GET One account by stake address
Returns on-chain information about an account given its stake address.
GET /api/core/accounts/{stake_address}
🎰 Parameters
| Name | Description | In | Type | Required |
|---|---|---|---|---|
| stake_address | Bech32 Stake address | path | string | true |
👨💻 Code samples
- Node.js
- Python
- Rust
const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' });
const accounts = await CBI.core.accounts_({ stake_address: "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma" });
console.log(accounts);
CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' });
accounts = await CBI.core.accounts_(stake_address='stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma');
print(accounts);
let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let accounts = CBI.core.accounts_(Some("stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma"), HashMap::new()).await.expect("Failed to call endpoint");
println!("accounts: {:?}", accounts);
💌 Response Codes
- 200
- 400
- 401
- 402
- 403
- 404
- 429
OK: Successful request.
{
"stake_address": "stake1u8a9qstrmj4rvc3k5z8fems7f0j2vztz8det2klgakhfc8ce79fma",
"is_registered": true,
"last_reg_dereg_tx": "5234f99b194603b2b0b63fff5d60ac9df916190360497d4f189e4ff4dd9130ff",
"last_reg_dereg_epoch_no": 289,
"pool_id": "pool1y24nj4qdkg35nvvnfawukauggsxrxuy74876cplmxsee29w5axc",
"last_deleg_tx": "004ac881d9fd1a6748a72547e82e89beb074e96c3a76670c5a11b494d9260f31",
"delegated_since_epoch_no": 472,
"total_balance": 134346239760,
"controlled_stakes": 92101860445,
"total_rewards": 42244379315,
"total_withdrawals": 0,
"available_rewards": 42244379315
}
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 |
|---|---|---|
| stake_address | string | The Bech32 encoded version of the account's stake address |
| is_registered | boolean | Boolean flag indicating if the account is registered (true) or deregistered (false) on-chain. |
| last_reg_dereg_tx | string | The hexadecimal encoding of the hash identifier of the last registration/deregistration transaction for this account. |
| last_reg_dereg_epoch_no | number(double) | Epoch number when the account was last registered/deregistered. |
| pool_id | string | The Bech32 encoding of the pool hash this account is delegated to. |
| last_deleg_tx | string | The hexadecimal encoding of the hash identifier of the last delegation transaction for this account. |
| delegated_since_epoch_no | number(double) | Epoch number when the current delegation became active for this account. |
| total_balance | number(double) | The total ADA balance of this account, e.g. controlled stakes + available rewards. |
| controlled_stakes | number(double) | The total ADA stakes controlled by this account. |
| total_rewards | number(double) | The total historical ADA rewards earned by this account. |
| total_withdrawals | number(double) | The total historical ADA rewards withdrew from this account. |
| available_rewards | number(double) | The available ADA rewards for this account. |
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.