CardanoBI API Documentation

Version: 1.0

Endpoints Summary

GET All relays
GET One pool relays by pool update unique identifier
GET One pool relays by VRF key hash
GET All relays OData
GET One pool relays by pool update unique identifier OData

GET All relays

Returns all pool relays.

GET /api/core/pools/relays/updates

👨‍💻 Code samples

Node.js
Python
Rust

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

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

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

💌 Response Codes

OK: Successful request.

[
 {
  "id": 1,
  "update_id": 1,
  "ipv4": "54.220.20.40",
  "ipv6": null,
  "dns_name": null,
  "dns_srv_name": null,
  "port": 3002
 },
 "...",
 {
  "id": 20,
  "update_id": 11,
  "ipv4": null,
  "ipv6": null,
  "dns_name": "relay0.bluecheesestakehouse.com",
  "dns_srv_name": null,
  "port": 5000
 }
]

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 relay unique identifier.
update_id	integer(int64)	The PoolUpdate table index this PoolRelay entry refers to.
ipv4	string	The IPv4 address of the relay.
ipv6	string	The IPv6 address of the relay.
dns_name	string	The DNS name of the relay.
dns_srv_name	string	The DNS service name of the relay.
port	integer(int32)	The port number of relay.

GET One pool relays by pool update unique identifier

Returns the relays for one pool given a pool update unique identifier.

GET /api/core/pools/relays/updates/{update_id}

🎰 Parameters

Name	Description	In	Type	Required
update_id	The pool update unique identifier	path	integer	true

👨‍💻 Code samples

Node.js
Python
Rust

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

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

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

💌 Response Codes

OK: Successful request.

[
 {
  "id": 1,
  "update_id": 1,
  "ipv4": "54.220.20.40",
  "ipv6": null,
  "dns_name": null,
  "dns_srv_name": null,
  "port": 3002
 },
 "...",
 {
  "id": 1,
  "update_id": 1,
  "ipv4": "54.220.20.40",
  "ipv6": null,
  "dns_name": null,
  "dns_srv_name": null,
  "port": 3002
 }
]

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 relay unique identifier.
update_id	integer(int64)	The PoolUpdate table index this PoolRelay entry refers to.
ipv4	string	The IPv4 address of the relay.
ipv6	string	The IPv6 address of the relay.
dns_name	string	The DNS name of the relay.
dns_srv_name	string	The DNS service name of the relay.
port	integer(int32)	The port number of relay.

GET One pool relays by VRF key hash

Returns the relays for one pool given its VRF key hash.

GET /api/core/pools/{vrf_key_hash}/relays/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 relays_updates = await CBI.core.pools.relays.updates_({ vrf_key_hash: "9be345bcbcb0cf0559b1135467fd2e4c78c741898cdf8bcb737b2dc5122632df" });
console.log(relays_updates); 

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

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

💌 Response Codes

OK: Successful request.

[
 {
  "id": 1,
  "update_id": 1,
  "ipv4": "54.220.20.40",
  "ipv6": null,
  "dns_name": null,
  "dns_srv_name": null,
  "port": 3002
 },
 "...",
 {
  "id": 20,
  "update_id": 11,
  "ipv4": null,
  "ipv6": null,
  "dns_name": "relay0.bluecheesestakehouse.com",
  "dns_srv_name": null,
  "port": 5000
 }
]

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 relay unique identifier.
update_id	integer(int64)	The PoolUpdate table index this PoolRelay entry refers to.
ipv4	string	The IPv4 address of the relay.
ipv6	string	The IPv6 address of the relay.
dns_name	string	The DNS name of the relay.
dns_srv_name	string	The DNS service name of the relay.
port	integer(int32)	The port number of relay.

GET All relays OData

Returns all pool relays.

GET /api/core/odata/poolsrelays

👨‍💻 Code samples

Node.js
Python
Rust

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

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

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

💌 Response Codes

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#PoolsRelays",
 "value": [
  {
   "id": 1,
   "update_id": 1,
   "ipv4": "54.220.20.40",
   "ipv6": null,
   "dns_name": null,
   "dns_srv_name": null,
   "port": 3002
  },
  "...",
  {
   "id": 20,
   "update_id": 11,
   "ipv4": null,
   "ipv6": null,
   "dns_name": "relay0.bluecheesestakehouse.com",
   "dns_srv_name": null,
   "port": 5000
  }
 ],
 "@odata.nextLink": "https://cardanobi.io/api/core/odata/poolsrelays?$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 relay unique identifier.
update_id	integer(int64)	The PoolUpdate table index this PoolRelay entry refers to.
ipv4	string	The IPv4 address of the relay.
ipv6	string	The IPv6 address of the relay.
dns_name	string	The DNS name of the relay.
dns_srv_name	string	The DNS service name of the relay.
port	integer(int32)	The port number of relay.

GET One pool relays by pool update unique identifier OData

Returns the relays for one pool given a pool update unique identifier.

GET /api/core/odata/poolsrelays/{update_id}

🎰 Parameters

Name	Description	In	Type	Required
update_id	The pool update unique identifier	path	integer	true

👨‍💻 Code samples

Node.js
Python
Rust

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

CBI = CardanoBI(apiKey='YOUR-KEY', apiSecret='YOUR-SECRET' }); 
poolsrelays = await CBI.core.poolsrelays_(odata=true,update_id=1);
print(poolsrelays); 

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

💌 Response Codes

OK: Successful request.

{
 "@odata.context": "https://cardanobi.io/api/core/odata/$metadata#PoolsRelays",
 "value": [
  {
   "id": 1,
   "update_id": 1,
   "ipv4": "54.220.20.40",
   "ipv6": null,
   "dns_name": null,
   "dns_srv_name": null,
   "port": 3002
  },
  "...",
  {
   "id": 1,
   "update_id": 1,
   "ipv4": "54.220.20.40",
   "ipv6": null,
   "dns_name": null,
   "dns_srv_name": null,
   "port": 3002
  }
 ]
}

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 relay unique identifier.
update_id	integer(int64)	The PoolUpdate table index this PoolRelay entry refers to.
ipv4	string	The IPv4 address of the relay.
ipv6	string	The IPv6 address of the relay.
dns_name	string	The DNS name of the relay.
dns_srv_name	string	The DNS service name of the relay.
port	integer(int32)	The port number of relay.

GET All relays​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One pool relays by pool update unique identifier​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One pool relays by VRF key hash​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET All relays OData​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET One pool relays by pool update unique identifier OData​

🎰 Parameters​

👨‍💻 Code samples​

💌 Response Codes​

💌 Response Schemas​

GET All relays

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One pool relays by pool update unique identifier

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One pool relays by VRF key hash

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET All relays OData

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas

GET One pool relays by pool update unique identifier OData

🎰 Parameters

👨‍💻 Code samples

💌 Response Codes

💌 Response Schemas