GET One asset
GET Asset list by policy
GET All assets
Returns the list of multi assets minted on Cardano.
GET /api/core/assets
🎰 Parameters
| Name | Description | In | Type | Required |
|---|---|---|---|---|
| page_no | Page number to retrieve - defaults to 1 | query | integer | false |
| page_size | Number of results per page - defaults to 20 - max 100 | query | integer | false |
| order | Prescribes in which order assets are returned - "desc" descending (default) from newest to oldest - "asc" ascending from oldest to newest | query | string | false |
👨💻 Code samples
- Node.js
- Python
- Rust
const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' });
const assets = await CBI.core.assets_();
console.log(assets);
CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' });
assets = await CBI.core.assets_();
print(assets);
let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let assets = CBI.core.assets_(HashMap::new()).await.expect("Failed to call endpoint");
println!("assets: {:?}", assets);
💌 Response Codes
- 200
- 400
- 401
- 402
- 403
- 404
- 429
OK: Successful request.
[
{
"asset_id": 10189163,
"fingerprint": "asset176m0gn0n0le8z9ayfewzx5lyhmadqw8g36sk4f",
"policy_hex": "8383f5950f92320dc2659c64c459dd903e1f6c1bb9830ba04df99455",
"total_supply": 1
},
"...",
{
"asset_id": 10189182,
"fingerprint": "asset157ncmac0cktkvx27tqtnvem89pml3njqrwt8a3",
"policy_hex": "0c2c9bb9c8f3c5f8efcef2bd1a127a19a5efc7b76e44cc3db272cd15",
"total_supply": 1
}
]
Bad Request: The request was unacceptable, often due to missing a required parameter.
Response schema is undefined.
Unauthorized: No valid API key provided.
Response schema is undefined.
Quota Exceeded: This API key has reached its usage limit on request.
Response schema is undefined.
Access Denied: The request is missing a valid API key or token.
Response schema is undefined.
Not Found: The requested resource cannot be found.
Response schema is undefined.
Too Many Requests: This API key has reached its rate limit.
Response schema is undefined.
💌 Response Schemas
- 200
- 400
- 401
- 402
- 403
- 404
- 429
Status Code 200
| Name | Type | Description |
|---|---|---|
| asset_id | integer(int64) | The MultiAsset unique identifier. |
| fingerprint | string | The CIP14 fingerprint for the MultiAsset. |
| policy_hex | string | The hexadecimal encoding of the MultiAsset policy hash. |
| total_supply | number(double) | The total supply of the Multi Asset. |
Status Code 400
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 401
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 402
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 403
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 404
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 429
| Name | Type | Description |
|---|
Response schema is undefined.
GET One asset
Returns the details of one multi asset minted on Cardano given its fingerprint.
GET /api/core/assets/{fingerprint}
🎰 Parameters
| Name | Description | In | Type | Required |
|---|---|---|---|---|
| fingerprint | The CIP14 fingerprint for the MultiAsset. | path | string | true |
👨💻 Code samples
- Node.js
- Python
- Rust
const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' });
const assets = await CBI.core.assets_({ fingerprint: "asset1w8wujx5xpxk88u94t0c60lsjlgwpd635a3c3lc" });
console.log(assets);
CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' });
assets = await CBI.core.assets_(fingerprint='asset1w8wujx5xpxk88u94t0c60lsjlgwpd635a3c3lc');
print(assets);
let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let assets = CBI.core.assets_(Some("asset1w8wujx5xpxk88u94t0c60lsjlgwpd635a3c3lc"), HashMap::new()).await.expect("Failed to call endpoint");
println!("assets: {:?}", assets);
💌 Response Codes
- 200
- 400
- 401
- 402
- 403
- 404
- 429
OK: Successful request.
[
"..."
]
Bad Request: The request was unacceptable, often due to missing a required parameter.
Response schema is undefined.
Unauthorized: No valid API key provided.
Response schema is undefined.
Quota Exceeded: This API key has reached its usage limit on request.
Response schema is undefined.
Access Denied: The request is missing a valid API key or token.
Response schema is undefined.
Not Found: The requested resource cannot be found.
Response schema is undefined.
Too Many Requests: This API key has reached its rate limit.
Response schema is undefined.
💌 Response Schemas
- 200
- 400
- 401
- 402
- 403
- 404
- 429
Status Code 200
| Name | Type | Description |
|---|---|---|
| asset_id | integer(int64) | The MultiAsset unique identifier. |
| fingerprint | string | The CIP14 fingerprint for the MultiAsset. |
| policy_hex | string | The hexadecimal encoding of the MultiAsset policy hash. |
| name | string | The MultiAsset name. |
| creation_time | string(date-time) | The MultiAsset creation time (first minting event time). |
| total_supply | number(double) | The MultiAsset total circulating supply. |
| mint_cnt | integer(int64) | The number of mint events for this MultiAsset. |
| burn_cnt | integer(int64) | The number of burn events for this MultiAsset. |
| first_mint_tx_hash | string | The hash for the transaction that contains the first minting event for this MultiAsset. |
| first_mint_keys | array | The metadata keys used in the first mint event for this MultiAsset. |
| last_mint_tx_hash | string | The hash for the transaction that contains the last minting event for this MultiAsset. |
| last_mint_keys | array | The metadata keys used in the last mint event for this MultiAsset. |
| first_mint_metadata | string | The JSON payload of the first mint event for this MultiAsset. |
Status Code 400
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 401
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 402
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 403
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 404
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 429
| Name | Type | Description |
|---|
Response schema is undefined.
GET Asset list by policy
Returns the list of MultiAsset for a specific policy given its hash.
GET /api/core/assets/policies/{policy_hash}
🎰 Parameters
| Name | Description | In | Type | Required |
|---|---|---|---|---|
| policy_hash | The MultiAsset policy hash. | path | string | true |
👨💻 Code samples
- Node.js
- Python
- Rust
const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' });
const policies = await CBI.core.assets.policies_({ policy_hash: "706e1c53ed984b016f2c0fc79a450fdb572aa21e4e87d6f74d0b6e8a" });
console.log(policies);
CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' });
policies = await CBI.core.assets.policies_(policy_hash='706e1c53ed984b016f2c0fc79a450fdb572aa21e4e87d6f74d0b6e8a');
print(policies);
let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let assets_policies = CBI.core.assets.policies_(Some("706e1c53ed984b016f2c0fc79a450fdb572aa21e4e87d6f74d0b6e8a"), HashMap::new()).await.expect("Failed to call endpoint");
println!("assets_policies: {:?}", assets_policies);
💌 Response Codes
- 200
- 400
- 401
- 402
- 403
- 404
- 429
OK: Successful request.
[
{
"fingerprint": "asset1q3f45cvfdk3jukj0u7tqc4c0yn7y0f4x8az2lk",
"total_supply": 1000000
},
"...",
{
"fingerprint": "asset1q3f45cvfdk3jukj0u7tqc4c0yn7y0f4x8az2lk",
"total_supply": 1000000
}
]
Bad Request: The request was unacceptable, often due to missing a required parameter.
Response schema is undefined.
Unauthorized: No valid API key provided.
Response schema is undefined.
Quota Exceeded: This API key has reached its usage limit on request.
Response schema is undefined.
Access Denied: The request is missing a valid API key or token.
Response schema is undefined.
Not Found: The requested resource cannot be found.
Response schema is undefined.
Too Many Requests: This API key has reached its rate limit.
Response schema is undefined.
💌 Response Schemas
- 200
- 400
- 401
- 402
- 403
- 404
- 429
Status Code 200
| Name | Type | Description |
|---|---|---|
| fingerprint | string | The CIP14 fingerprint for the MultiAsset. |
| total_supply | number(double) | The total supply of the Multi Asset. |
Status Code 400
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 401
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 402
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 403
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 404
| Name | Type | Description |
|---|
Response schema is undefined.
Status Code 429
| Name | Type | Description |
|---|
Response schema is undefined.