CardanoBI API Documentation

Version: 1.0

Endpoints Summary

GET All on-chain pool updates
GET One pool on-chain updates
GET One pool on-chain updates
GET All on-chain pool updates OData
GET One pool on-chain updates OData

GET All on-chain pool updates

Returns all on-chain pool updates.

GET /api/core/pools/updates

👨‍💻 Code samples

Node.js
Python
Rust

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const updates = await CBI.core.pools.updates_();
console.log(updates); 

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
updates = await CBI.core.pools.updates_();
print(updates); 

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

💌 Response Codes

OK: Successful request.

[
 {
  "id": 1,
  "hash_id": 1,
  "cert_index": 0,
  "vrf_key_hash": "AiCl0Irb/pVUtS17KZO+WJKsP/NA5nSjd96j4irRd4s=",
  "pledge": 450000000000,
  "active_epoch_no": 210,
  "meta_id": 1,
  "margin": 0.015,
  "fixed_cost": 340000000,
  "registered_tx_id": 2415556,
  "reward_addr_id": 61,
  "vrf_key_hash_hex": "0220a5d08adbfe9554b52d7b2993be5892ac3ff340e674a377dea3e22ad1778b"
 },
 "...",
 {
  "id": 20,
  "hash_id": 20,
  "cert_index": 0,
  "vrf_key_hash": "e2a6GbiEHiaskUwffALAPqWru5bNjRZRsZ6rxlufk+8=",
  "pledge": 50000000000,
  "active_epoch_no": 210,
  "meta_id": 20,
  "margin": 0.03,
  "fixed_cost": 340000000,
  "registered_tx_id": 2416313,
  "reward_addr_id": 111,
  "vrf_key_hash_hex": "7b66ba19b8841e26ac914c1f7c02c03ea5abbb96cd8d1651b19eabc65b9f93ef"
 }
]

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

Status Code 200

Name	Type	Description
id	integer(int64)	The pool update unique identifier.
hash_id	integer(int64)	The PoolHash table index of the pool this update refers to.
cert_index	integer(int32)	The index of this pool update within the certificates of this transaction.
vrf_key_hash	string(byte)	The hash of the pool's VRF key.
pledge	number(double)	The amount (in Lovelace) the pool owner pledges to the pool.
active_epoch_no	integer(int64)	The epoch number where this update becomes active.
meta_id	integer(int64)	The PoolMetadataRef table index this pool update refers to.
margin	number(double)	The margin (as a percentage) this pool charges.
fixed_cost	number(double)	The fixed per epoch fee (in ADA) this pool charges.
registered_tx_id	integer(int64)	The Tx table index of the transaction in which provided this pool update.
reward_addr_id	integer(int64)	The StakeAddress table index of this pool's rewards address. New in v13: Replaced reward_addr.
vrf_key_hash_hex	string	The hexadecimal encoding of the VRF key hash.

GET One pool on-chain updates

Returns the on-chain updates for one pool given its unique identifier.

GET /api/core/pools/{pool_id}/updates

🎰 Parameters

Name	Description	In	Type	Required
pool_id	Pool unique identifier	path	integer	true

👨‍💻 Code samples

Node.js
Python
Rust

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const updates = await CBI.core.pools.updates_({ pool_id: 4268 });
console.log(updates); 

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
updates = await CBI.core.pools.updates_(pool_id=4268);
print(updates); 

let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let updates_updates = CBI.core.pools.updates_(Some(4268), HashMap::new()).await.expect("Failed to call endpoint");
println!("updates_updates: {:?}", updates_updates); 

💌 Response Codes

OK: Successful request.

[
 {
  "id": 22010,
  "hash_id": 4268,
  "cert_index": 0,
  "vrf_key_hash": "m+NFvLywzwVZsRNUZ/0uTHjHQYmM34vLc3stxRImMt8=",
  "pledge": 10000000000,
  "active_epoch_no": 291,
  "meta_id": 21950,
  "margin": 0.05,
  "fixed_cost": 340000000,
  "registered_tx_id": 12623716,
  "reward_addr_id": 2480780,
  "vrf_key_hash_hex": "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"
 },
 "...",
 {
  "id": 33494,
  "hash_id": 4268,
  "cert_index": 0,
  "vrf_key_hash": "m+NFvLywzwVZsRNUZ/0uTHjHQYmM34vLc3stxRImMt8=",
  "pledge": 130000000000,
  "active_epoch_no": 473,
  "meta_id": 33370,
  "margin": 0.0299,
  "fixed_cost": 340000000,
  "registered_tx_id": 86928296,
  "reward_addr_id": 2480780,
  "vrf_key_hash_hex": "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"
 }
]

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

Status Code 200

Name	Type	Description
id	integer(int64)	The pool update unique identifier.
hash_id	integer(int64)	The PoolHash table index of the pool this update refers to.
cert_index	integer(int32)	The index of this pool update within the certificates of this transaction.
vrf_key_hash	string(byte)	The hash of the pool's VRF key.
pledge	number(double)	The amount (in Lovelace) the pool owner pledges to the pool.
active_epoch_no	integer(int64)	The epoch number where this update becomes active.
meta_id	integer(int64)	The PoolMetadataRef table index this pool update refers to.
margin	number(double)	The margin (as a percentage) this pool charges.
fixed_cost	number(double)	The fixed per epoch fee (in ADA) this pool charges.
registered_tx_id	integer(int64)	The Tx table index of the transaction in which provided this pool update.
reward_addr_id	integer(int64)	The StakeAddress table index of this pool's rewards address. New in v13: Replaced reward_addr.
vrf_key_hash_hex	string	The hexadecimal encoding of the VRF key hash.

GET One pool on-chain updates

Returns the on-chain updates for one pool given its VRF key hash.

GET /api/core/pools/{vrf_key_hash}/updates

🎰 Parameters

Name	Description	In	Type	Required
vrf_key_hash	The pool VRF key in HEX format.	path	string	true

👨‍💻 Code samples

Node.js
Python
Rust

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const updates = await CBI.core.pools.updates_({ vrf_key_hash: "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df" });
console.log(updates); 

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
updates = await CBI.core.pools.updates_(vrf_key_hash='9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df');
print(updates); 

let CBI = CardanoBI::new(Some("YOUR-KEY"), Some("YOUR-SECRET")).await.expect("Failed to initialize CardanoBI");
let updates_updates = CBI.core.pools.updates_(Some("9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"), HashMap::new()).await.expect("Failed to call endpoint");
println!("updates_updates: {:?}", updates_updates); 

💌 Response Codes

OK: Successful request.

[
 {
  "id": 22010,
  "hash_id": 4268,
  "cert_index": 0,
  "vrf_key_hash": "m+NFvLywzwVZsRNUZ/0uTHjHQYmM34vLc3stxRImMt8=",
  "pledge": 10000000000,
  "active_epoch_no": 291,
  "meta_id": 21950,
  "margin": 0.05,
  "fixed_cost": 340000000,
  "registered_tx_id": 12623716,
  "reward_addr_id": 2480780,
  "vrf_key_hash_hex": "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"
 },
 "...",
 {
  "id": 33494,
  "hash_id": 4268,
  "cert_index": 0,
  "vrf_key_hash": "m+NFvLywzwVZsRNUZ/0uTHjHQYmM34vLc3stxRImMt8=",
  "pledge": 130000000000,
  "active_epoch_no": 473,
  "meta_id": 33370,
  "margin": 0.0299,
  "fixed_cost": 340000000,
  "registered_tx_id": 86928296,
  "reward_addr_id": 2480780,
  "vrf_key_hash_hex": "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"
 }
]

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

Status Code 200

Name	Type	Description
id	integer(int64)	The pool update unique identifier.
hash_id	integer(int64)	The PoolHash table index of the pool this update refers to.
cert_index	integer(int32)	The index of this pool update within the certificates of this transaction.
vrf_key_hash	string(byte)	The hash of the pool's VRF key.
pledge	number(double)	The amount (in Lovelace) the pool owner pledges to the pool.
active_epoch_no	integer(int64)	The epoch number where this update becomes active.
meta_id	integer(int64)	The PoolMetadataRef table index this pool update refers to.
margin	number(double)	The margin (as a percentage) this pool charges.
fixed_cost	number(double)	The fixed per epoch fee (in ADA) this pool charges.
registered_tx_id	integer(int64)	The Tx table index of the transaction in which provided this pool update.
reward_addr_id	integer(int64)	The StakeAddress table index of this pool's rewards address. New in v13: Replaced reward_addr.
vrf_key_hash_hex	string	The hexadecimal encoding of the VRF key hash.

GET All on-chain pool updates OData

Returns all on-chain pool updates.

GET /api/core/odata/poolsupdates

👨‍💻 Code samples

Node.js
Python
Rust

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

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
poolsupdates = await CBI.core.poolsupdates_(odata=true);
print(poolsupdates); 

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

💌 Response Codes

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#PoolsUpdates",
 "value": [
  {
   "id": 1,
   "hash_id": 1,
   "cert_index": 0,
   "vrf_key_hash": "AiCl0Irb/pVUtS17KZO+WJKsP/NA5nSjd96j4irRd4s=",
   "pledge": 450000000000,
   "active_epoch_no": 210,
   "meta_id": 1,
   "margin": 0.015,
   "fixed_cost": 340000000,
   "registered_tx_id": 2415556,
   "reward_addr_id": 61,
   "vrf_key_hash_hex": "0220a5d08adbfe9554b52d7b2993be5892ac3ff340e674a377dea3e22ad1778b"
  },
  "...",
  {
   "id": 20,
   "hash_id": 20,
   "cert_index": 0,
   "vrf_key_hash": "e2a6GbiEHiaskUwffALAPqWru5bNjRZRsZ6rxlufk+8=",
   "pledge": 50000000000,
   "active_epoch_no": 210,
   "meta_id": 20,
   "margin": 0.03,
   "fixed_cost": 340000000,
   "registered_tx_id": 2416313,
   "reward_addr_id": 111,
   "vrf_key_hash_hex": "7b66ba19b8841e26ac914c1f7c02c03ea5abbb96cd8d1651b19eabc65b9f93ef"
  }
 ],
 "@odata.nextLink": "https://cardanobi.io/api/core/odata/poolsupdates?$skip=20"
}

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

Status Code 200

Name	Type	Description
id	integer(int64)	The pool update unique identifier.
hash_id	integer(int64)	The PoolHash table index of the pool this update refers to.
cert_index	integer(int32)	The index of this pool update within the certificates of this transaction.
vrf_key_hash	string(byte)	The hash of the pool's VRF key.
pledge	number(double)	The amount (in Lovelace) the pool owner pledges to the pool.
active_epoch_no	integer(int64)	The epoch number where this update becomes active.
meta_id	integer(int64)	The PoolMetadataRef table index this pool update refers to.
margin	number(double)	The margin (as a percentage) this pool charges.
fixed_cost	number(double)	The fixed per epoch fee (in ADA) this pool charges.
registered_tx_id	integer(int64)	The Tx table index of the transaction in which provided this pool update.
reward_addr_id	integer(int64)	The StakeAddress table index of this pool's rewards address. New in v13: Replaced reward_addr.
vrf_key_hash_hex	string	The hexadecimal encoding of the VRF key hash.

GET One pool on-chain updates OData

Returns the on-chain updates for one pool given its unique identifier.

GET /api/core/odata/poolsupdates/{pool_id}

🎰 Parameters

Name	Description	In	Type	Required
pool_id	Pool unique identifier	path	integer	true

👨‍💻 Code samples

Node.js
Python
Rust

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const poolsupdates = await CBI.core.poolsupdates_({ "odata": true, pool_id: 4268 });
console.log(poolsupdates); 

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
poolsupdates = await CBI.core.poolsupdates_(odata=true,pool_id=4268);
print(poolsupdates); 

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

💌 Response Codes

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#PoolsUpdates",
 "value": [
  {
   "id": 22010,
   "hash_id": 4268,
   "cert_index": 0,
   "vrf_key_hash": "m+NFvLywzwVZsRNUZ/0uTHjHQYmM34vLc3stxRImMt8=",
   "pledge": 10000000000,
   "active_epoch_no": 291,
   "meta_id": 21950,
   "margin": 0.05,
   "fixed_cost": 340000000,
   "registered_tx_id": 12623716,
   "reward_addr_id": 2480780,
   "vrf_key_hash_hex": "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"
  },
  "...",
  {
   "id": 33494,
   "hash_id": 4268,
   "cert_index": 0,
   "vrf_key_hash": "m+NFvLywzwVZsRNUZ/0uTHjHQYmM34vLc3stxRImMt8=",
   "pledge": 130000000000,
   "active_epoch_no": 473,
   "meta_id": 33370,
   "margin": 0.0299,
   "fixed_cost": 340000000,
   "registered_tx_id": 86928296,
   "reward_addr_id": 2480780,
   "vrf_key_hash_hex": "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df"
  }
 ]
}

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

Status Code 200

Name	Type	Description
id	integer(int64)	The pool update unique identifier.
hash_id	integer(int64)	The PoolHash table index of the pool this update refers to.
cert_index	integer(int32)	The index of this pool update within the certificates of this transaction.
vrf_key_hash	string(byte)	The hash of the pool's VRF key.
pledge	number(double)	The amount (in Lovelace) the pool owner pledges to the pool.
active_epoch_no	integer(int64)	The epoch number where this update becomes active.
meta_id	integer(int64)	The PoolMetadataRef table index this pool update refers to.
margin	number(double)	The margin (as a percentage) this pool charges.
fixed_cost	number(double)	The fixed per epoch fee (in ADA) this pool charges.
registered_tx_id	integer(int64)	The Tx table index of the transaction in which provided this pool update.
reward_addr_id	integer(int64)	The StakeAddress table index of this pool's rewards address. New in v13: Replaced reward_addr.
vrf_key_hash_hex	string	The hexadecimal encoding of the VRF key hash.

GET All on-chain pool updates​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One pool on-chain updates​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One pool on-chain updates​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET All on-chain pool updates OData​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One pool on-chain updates OData​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET All on-chain pool updates

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One pool on-chain updates

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One pool on-chain updates

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET All on-chain pool updates OData

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One pool on-chain updates OData

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas