GET One address stats per epoch
Returns statistics for one given address (Enterprise, Payment or Staking), for all epochs or an epoch range.
GET /api/bi/addresses/{address}/stats
🎰 Parameters
| Name | Description | In | Type | Required |
|---|---|---|---|---|
| address | An Enterprise address, a Payment address or a Staking address (e.g. an account) | path | string | true |
| epoch_no_min | Epoch range lower bound | query | integer | false |
| epoch_no_max | Epoch range upper bound | query | integer | false |
| 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 the delegation events 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 stats = await CBI.bi.addresses.stats_({ address: "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma" });
console.log(stats);
CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' });
stats = await CBI.bi.addresses.stats_(address='stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma');
print(stats);
let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let stats_stats = CBI.bi.addresses.stats_(Some("stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma"), HashMap::new()).await.expect("Failed to call endpoint");
println!("stats_stats: {:?}", stats_stats);
💌 Response Codes
- 200
- 400
- 401
- 402
- 403
- 404
- 429
OK: Successful request.
[
{
"epoch_no": 470,
"address": "addr1qyyc97lwzpvsgnywpf2awx2dylzgkta36j8fevpncf2yvdh62pqk8h92xe3rdgywnnhpujly5cykywmjk4d73mdwns0sem8e5r",
"stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
"tx_count": 2
},
"...",
{
"epoch_no": 289,
"address": "addr1qyyc97lwzpvsgnywpf2awx2dylzgkta36j8fevpncf2yvdh62pqk8h92xe3rdgywnnhpujly5cykywmjk4d73mdwns0sem8e5r",
"stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
"tx_count": 4
}
]
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 |
|---|---|---|
| epoch_no | integer(int32) | The epoch number. |
| address | string | The enterprise or payment address. |
| stake_address | string | The stake addres. |
| tx_count | integer(int64) | The transaction count. |
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.