Version: 1.0

Endpoints Summary

GET One address information
GET One address information OData

GET One address information

Returns useful information for one given payment address or all payment addresses linked to a given stake address.

GET /api/core/addresses/{address}/info

🎰 Parameters

Name	Description	In	Type	Required
address	A payment address or a stake address	path	string	true

👨‍💻 Code samples

Node.js

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const info = await CBI.core.addresses.info_({ address: "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma" });
console.log(info); 

Python

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
info = await CBI.core.addresses.info_(address='stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma');
print(info); 

Rust

let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let info_info = CBI.core.addresses.info_(Some("stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma"), HashMap::new()).await.expect("Failed to call endpoint");
println!("info_info: {:?}", info_info); 

💌 Response Codes

200

OK: Successful request.

[
 {
  "address": "addr1qyyc97lwzpvsgnywpf2awx2dylzgkta36j8fevpncf2yvdh62pqk8h92xe3rdgywnnhpujly5cykywmjk4d73mdwns0sem8e5r",
  "stake_address_id": 2480780,
  "stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
  "script_hash": null
 },
 "...",
 {
  "address": "addr1qyyc97lwzpvsgnywpf2awx2dylzgkta36j8fevpncf2yvdh62pqk8h92xe3rdgywnnhpujly5cykywmjk4d73mdwns0sem8e5r",
  "stake_address_id": 2480780,
  "stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
  "script_hash": null
 }
]

400

Bad Request: The request was unacceptable, often due to missing a required parameter.

Response schema is undefined.

401

Unauthorized: No valid API key provided.

Response schema is undefined.

402

Quota Exceeded: This API key has reached its usage limit on request.

Response schema is undefined.

403

Access Denied: The request is missing a valid API key or token.

Response schema is undefined.

404

Not Found: The requested resource cannot be found.

Response schema is undefined.

429

Too Many Requests: This API key has reached its rate limit.

Response schema is undefined.

💌 Response Schemas

200

Status Code 200

Name	Type	Description
address	string	The address.
stake_address_id	integer(int64)	The stake addres unique identifier.
stake_address	string	The stake address.
script_hash	string	The script hash in HEX form in case this address is locked by a script.

400

Status Code 400

Name	Type	Description

Response schema is undefined.

401

Status Code 401

Name	Type	Description

Response schema is undefined.

402

Status Code 402

Name	Type	Description

Response schema is undefined.

403

Status Code 403

Name	Type	Description

Response schema is undefined.

404

Status Code 404

Name	Type	Description

Response schema is undefined.

429

Status Code 429

Name	Type	Description

Response schema is undefined.

GET One address information OData

Returns useful information for one given payment address or all payment addresses linked to a given stake address.

GET /api/core/odata/addressesinfo/{address}

🎰 Parameters

Name	Description	In	Type	Required
address	A payment address or a stake address	path	string	true

👨‍💻 Code samples

Node.js

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const addressesinfo = await CBI.core.addressesinfo_({ "odata": true, address: "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma" });
console.log(addressesinfo); 

Python

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
addressesinfo = await CBI.core.addressesinfo_(odata=true,address='stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma');
print(addressesinfo); 

Rust

let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let addressesinfo = CBI.core.addressesinfo_(Some("stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma"), HashMap::from([("odata", "true")])).await.expect("Failed to call endpoint");
println!("addressesinfo: {:?}", addressesinfo); 

💌 Response Codes

200

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#AddressesInfo",
 "value": [
  {
   "address": "addr1qyyc97lwzpvsgnywpf2awx2dylzgkta36j8fevpncf2yvdh62pqk8h92xe3rdgywnnhpujly5cykywmjk4d73mdwns0sem8e5r",
   "stake_address_id": 2480780,
   "stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
   "script_hash": null
  },
  "...",
  {
   "address": "addr1qyyc97lwzpvsgnywpf2awx2dylzgkta36j8fevpncf2yvdh62pqk8h92xe3rdgywnnhpujly5cykywmjk4d73mdwns0sem8e5r",
   "stake_address_id": 2480780,
   "stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
   "script_hash": null
  }
 ]
}

400

Bad Request: The request was unacceptable, often due to missing a required parameter.

Response schema is undefined.

401

Unauthorized: No valid API key provided.

Response schema is undefined.

402

Quota Exceeded: This API key has reached its usage limit on request.

Response schema is undefined.

403

Access Denied: The request is missing a valid API key or token.

Response schema is undefined.

404

Not Found: The requested resource cannot be found.

Response schema is undefined.

429

Too Many Requests: This API key has reached its rate limit.

Response schema is undefined.

💌 Response Schemas

200

Status Code 200

Name	Type	Description
address	string	The address.
stake_address_id	integer(int64)	The stake addres unique identifier.
stake_address	string	The stake address.
script_hash	string	The script hash in HEX form in case this address is locked by a script.

400

Status Code 400

Name	Type	Description

Response schema is undefined.

401

Status Code 401

Name	Type	Description

Response schema is undefined.

402

Status Code 402

Name	Type	Description

Response schema is undefined.

403

Status Code 403

Name	Type	Description

Response schema is undefined.

404

Status Code 404

Name	Type	Description

Response schema is undefined.

429

Status Code 429

Name	Type	Description

Response schema is undefined.