Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cardano Cardano » Pools API

The Cardano » Pools API from Cardano — 12 operation(s) for cardano » pools.

Cardano Cardano » Pools API is one of 21 APIs that Cardano publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cardano » Pools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 12 operations across 12 paths, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 0.1.89.

Requests are made against 4 base URLs: https://cardano-mainnet.blockfrost.io/api/v0, https://cardano-preprod.blockfrost.io/api/v0, https://cardano-preview.blockfrost.io/api/v0, https://localhost:3000.

12 operations 12 paths 12 schemas 12 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.1.89
Base URL
https://cardano-mainnet.blockfrost.io/api/v0
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Cardano Cardano » Pools API declares 1 security scheme for authenticating requests. An API key is passed in the header as project_id (project_id). By default, every request must be authenticated.

  • project_id — There are multiple token types available based on network you choose when creating a Blockfrost a project, for a list of token types see available networks.

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 12 GET. Each is listed below with its method, path, parameters, and response codes.

Cardano » Pools 12
GET
/pools
List of stake pools
3 params → 200400403404418429500
GET
/pools/extended
List of stake pools with additional information
3 params → 200400403404418429500
GET
/pools/retired
List of retired stake pools
3 params → 200400403404418429500
GET
/pools/retiring
List of retiring stake pools
3 params → 200400403404418429500
GET
/pools/{pool_id}
Specific stake pool
1 param → 200400403404418429500
GET
/pools/{pool_id}/history
Stake pool history
4 params → 200400403404418429500
GET
/pools/{pool_id}/metadata
Stake pool metadata
1 param → 200400403404418429500
GET
/pools/{pool_id}/relays
Stake pool relays
1 param → 200400403404418429500
GET
/pools/{pool_id}/delegators
Stake pool delegators
4 params → 200400403404418429500
GET
/pools/{pool_id}/blocks
Stake pool blocks
4 params → 200400403404418429500
GET
/pools/{pool_id}/updates
Stake pool updates
4 params → 200400403404418429500
GET
/pools/{pool_id}/votes
Stake pool votes
4 params → 200400403404418429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are pool (20 properties), pool_metadata (9 properties). Each schema is shown below with its type and property counts.

pool_list_retire
array
pool_list
array
pool_blocks
array
pool_metadata
object
9 properties 8 required
pool_list_extended
array
pool_delegators
array
pool_votes
array
pool_relays
array
pool_updates
array
pool_history
array
pool
object
20 properties 20 required
empty_object
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cardano-cardano-pools-api-openapi.yml Raw ↑

Other APIs Cardano publishes across the network.

Blockfrost IPFS API
Cardano Cardano » Accounts API
Cardano Cardano » Addresses API
Cardano Cardano » Assets API
Cardano Cardano » Blocks API
Cardano Cardano » Epochs API
Cardano Cardano » Governance API
Cardano Cardano » Ledger API
Cardano Cardano » Mempool API
Cardano Cardano » Metadata API
Cardano Cardano » Network API
Cardano Cardano » Scripts API