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 » Governance API

The Cardano » Governance API from Cardano — 20 operation(s) for cardano » governance.

Cardano Cardano » Governance 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 » Governance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 20 operations across 20 paths, and defines 15 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.

20 operations 20 paths 15 schemas 20 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 » Governance 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 20

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

Cardano » Governance 20
GET
/governance/committee
Constitutional committee
→ 200400403404418429500
GET
/governance/committee/votes
Constitutional committee votes
3 params → 200400403418429500
GET
/governance/committee/{cc_id}/votes
Constitutional committee member votes
4 params → 200400403418429500
GET
/governance/dreps
Delegate Representatives (DReps)
6 params → 200400403418429500
GET
/governance/dreps/{drep_id}
Specific DRep
1 param → 200400403418429500
GET
/governance/dreps/{drep_id}/delegators
DRep delegators
4 params → 200400403418429500
GET
/governance/dreps/{drep_id}/metadata
DRep metadata
1 param → 200400403418429500
GET
/governance/dreps/{drep_id}/updates
DRep updates
4 params → 200400403418429500
GET
/governance/dreps/{drep_id}/votes
DRep votes
4 params → 200400403418429500
GET
/governance/proposals
Proposals
3 params → 200400403418429500
GET
/governance/proposals/{tx_hash}/{cert_index}
Specific proposal
2 params → 200400403418429500
GET
/governance/proposals/{tx_hash}/{cert_index}/parameters
Specific parameters proposal
2 params → 200400403404418429500
GET
/governance/proposals/{tx_hash}/{cert_index}/withdrawals
Specific withdrawals proposal
5 params → 200400403404418429500
GET
/governance/proposals/{tx_hash}/{cert_index}/votes
Proposal votes
5 params → 200400403418429500
GET
/governance/proposals/{tx_hash}/{cert_index}/metadata
Specific proposal metadata
2 params → 200400403418429500
GET
/governance/proposals/{gov_action_id}
GovActionID proposal
1 param → 200400403418429500
GET
/governance/proposals/{gov_action_id}/parameters
GovActionID Proposal parameters
1 param → 200400403404418429500
GET
/governance/proposals/{gov_action_id}/withdrawals
GovActionID Proposal withdrawals
4 params → 200400403404418429500
GET
/governance/proposals/{gov_action_id}/votes
GovActionID Proposal votes
4 params → 200400403418429500
GET
/governance/proposals/{gov_action_id}/metadata
GovActionID proposal metadata
1 param → 200400403418429500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are proposal (12 properties), drep (9 properties), proposal_metadata_v2 (8 properties), proposal_metadata (7 properties). Each schema is shown below with its type and property counts.

committee_votes
array
proposal_withdrawals
array
drep
object
9 properties 9 required
proposal
object
12 properties 12 required
drep_metadata
object
7 properties 6 required
proposals
array
drep_updates
array
dreps
array
proposal_metadata_v2
object
8 properties 7 required
drep_votes
array
committee
object
6 properties 6 required
proposal_metadata
object
7 properties 7 required
proposal_parameters
object
4 properties 4 required
proposal_votes
array
drep_delegators
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cardano-cardano-governance-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 » Ledger API
Cardano Cardano » Mempool API
Cardano Cardano » Metadata API
Cardano Cardano » Network API
Cardano Cardano » Pools API
Cardano Cardano » Scripts API