CardanoBI API Documentation

Version: 1.0

Endpoints Summary

GET Latest epoch
GET All epochs
GET One epoch by number
GET All epochs OData
GET One epoch by number OData

GET Latest epoch

Returns info about the latest epoch.

GET /api/core/epochs/latest

👨‍💻 Code samples

Node.js
Python
Rust

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

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
latest = await CBI.core.epochs.latest_();
print(latest); 

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

💌 Response Codes

OK: Successful request.

{
 "id": 497,
 "out_sum": 60717832669187390,
 "fees": 50087393902,
 "tx_count": 148344,
 "blk_count": 11423,
 "no": 496,
 "start_time": "2024-07-08T21:45:12",
 "end_time": "2024-07-11T15:02:37"
}

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 epoch unique identifier.
out_sum	number(double)	The sum of the transaction output values (in Lovelace) in this epoch.
fees	number(double)	The sum of the fees (in Lovelace) in this epoch.
tx_count	integer(int32)	The number of transactions in this epoch.
blk_count	integer(int32)	The number of blocks in this epoch.
no	integer(int32)	The epoch number.
start_time	string(date-time)	The epoch start time.
end_time	string(date-time)	The epoch end time.

GET All epochs

Returns all epoch entities.

GET /api/core/epochs

👨‍💻 Code samples

Node.js
Python
Rust

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

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
epochs = await CBI.core.epochs_();
print(epochs); 

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

💌 Response Codes

OK: Successful request.

[
 {
  "id": 1,
  "out_sum": 10378568796482912,
  "fees": 3458053,
  "tx_count": 33,
  "blk_count": 21587,
  "no": 0,
  "start_time": "2017-09-23T21:44:51",
  "end_time": "2017-09-28T21:44:31"
 },
 "...",
 {
  "id": 20,
  "out_sum": 33234287940816696,
  "fees": 3786897619,
  "tx_count": 22136,
  "blk_count": 21597,
  "no": 19,
  "start_time": "2017-12-27T21:44:51",
  "end_time": "2018-01-01T21:44:31"
 }
]

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 epoch unique identifier.
out_sum	number(double)	The sum of the transaction output values (in Lovelace) in this epoch.
fees	number(double)	The sum of the fees (in Lovelace) in this epoch.
tx_count	integer(int32)	The number of transactions in this epoch.
blk_count	integer(int32)	The number of blocks in this epoch.
no	integer(int32)	The epoch number.
start_time	string(date-time)	The epoch start time.
end_time	string(date-time)	The epoch end time.

GET One epoch by number

Returns one specific epoch given its number.

GET /api/core/epochs/{epoch_no}

🎰 Parameters

Name	Description	In	Type	Required
epoch_no	Epoch number	path	integer	true

👨‍💻 Code samples

Node.js
Python
Rust

const CBI = await new CardanoBI({ apiKey: 'YOUR-KEY', apiSecret: 'YOUR-SECRET' }); 
const epochs = await CBI.core.epochs_({ epoch_no: 394 });
console.log(epochs); 

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
epochs = await CBI.core.epochs_(epoch_no=394);
print(epochs); 

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

💌 Response Codes

OK: Successful request.

[
 {
  "id": 1,
  "out_sum": 10378568796482912,
  "fees": 3458053,
  "tx_count": 33,
  "blk_count": 21587,
  "no": 0,
  "start_time": "2017-09-23T21:44:51",
  "end_time": "2017-09-28T21:44:31"
 },
 "...",
 {
  "id": 20,
  "out_sum": 33234287940816696,
  "fees": 3786897619,
  "tx_count": 22136,
  "blk_count": 21597,
  "no": 19,
  "start_time": "2017-12-27T21:44:51",
  "end_time": "2018-01-01T21:44:31"
 }
]

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 epoch unique identifier.
out_sum	number(double)	The sum of the transaction output values (in Lovelace) in this epoch.
fees	number(double)	The sum of the fees (in Lovelace) in this epoch.
tx_count	integer(int32)	The number of transactions in this epoch.
blk_count	integer(int32)	The number of blocks in this epoch.
no	integer(int32)	The epoch number.
start_time	string(date-time)	The epoch start time.
end_time	string(date-time)	The epoch end time.

GET All epochs OData

Returns all epoch entities.

GET /api/core/odata/epochs

👨‍💻 Code samples

Node.js
Python
Rust

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

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

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

💌 Response Codes

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#Epochs",
 "value": [
  {
   "id": 1,
   "out_sum": 10378568796482912,
   "fees": 3458053,
   "tx_count": 33,
   "blk_count": 21587,
   "no": 0,
   "start_time": "2017-09-23T21:44:51Z",
   "end_time": "2017-09-28T21:44:31Z"
  },
  "...",
  {
   "id": 20,
   "out_sum": 33234287940816696,
   "fees": 3786897619,
   "tx_count": 22136,
   "blk_count": 21597,
   "no": 19,
   "start_time": "2017-12-27T21:44:51Z",
   "end_time": "2018-01-01T21:44:31Z"
  }
 ],
 "@odata.nextLink": "https://cardanobi.io/api/core/odata/epochs?$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 epoch unique identifier.
out_sum	number(double)	The sum of the transaction output values (in Lovelace) in this epoch.
fees	number(double)	The sum of the fees (in Lovelace) in this epoch.
tx_count	integer(int32)	The number of transactions in this epoch.
blk_count	integer(int32)	The number of blocks in this epoch.
no	integer(int32)	The epoch number.
start_time	string(date-time)	The epoch start time.
end_time	string(date-time)	The epoch end time.

GET One epoch by number OData

Returns one specific epoch given its number.

GET /api/core/odata/epochs/{epoch_no}

🎰 Parameters

Name	Description	In	Type	Required
epoch_no	Epoch number	path	integer	true

👨‍💻 Code samples

Node.js
Python
Rust

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

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
epochs = await CBI.core.epochs_(odata=true,epoch_no=394);
print(epochs); 

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

💌 Response Codes

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#Epochs",
 "value": [
  {
   "id": 1,
   "out_sum": 10378568796482912,
   "fees": 3458053,
   "tx_count": 33,
   "blk_count": 21587,
   "no": 0,
   "start_time": "2017-09-23T21:44:51Z",
   "end_time": "2017-09-28T21:44:31Z"
  },
  "...",
  {
   "id": 20,
   "out_sum": 33234287940816696,
   "fees": 3786897619,
   "tx_count": 22136,
   "blk_count": 21597,
   "no": 19,
   "start_time": "2017-12-27T21:44:51Z",
   "end_time": "2018-01-01T21:44:31Z"
  }
 ],
 "@odata.nextLink": "https://cardanobi.io/api/core/odata/epochs?$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 epoch unique identifier.
out_sum	number(double)	The sum of the transaction output values (in Lovelace) in this epoch.
fees	number(double)	The sum of the fees (in Lovelace) in this epoch.
tx_count	integer(int32)	The number of transactions in this epoch.
blk_count	integer(int32)	The number of blocks in this epoch.
no	integer(int32)	The epoch number.
start_time	string(date-time)	The epoch start time.
end_time	string(date-time)	The epoch end time.

GET Latest epoch​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET All epochs​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One epoch by number​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET All epochs OData​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One epoch by number OData​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET Latest epoch

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET All epochs

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One epoch by number

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET All epochs OData

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One epoch by number OData

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas