Lib.rs

› Cryptography › Magic Beans › Blockfrost
#blockchain #blockchain-transaction #stake #cardano #transaction #epoch #certificate #utxo #ipfs #proposal

blockfrost-openapi

Blockfrost is an API as a service that allows users to interact with the Cardano blockchain and parts of its ecosystem. This crate provides a Rust models for the Blockfrost API.

Owned by Vladimír Volek.

5 releases

0.1.75 Apr 14, 2025
0.1.69 Nov 13, 2024
0.0.3 Nov 7, 2023
0.0.2 Nov 7, 2023
0.0.1 Nov 1, 2023

#2 in #utxo

Download history 67/week @ 2025-02-19 98/week @ 2025-02-26 93/week @ 2025-03-05 128/week @ 2025-03-12 87/week @ 2025-03-19 49/week @ 2025-03-26 118/week @ 2025-04-02 144/week @ 2025-04-09 58/week @ 2025-04-16 55/week @ 2025-04-23 24/week @ 2025-04-30 37/week @ 2025-05-07 58/week @ 2025-05-14 65/week @ 2025-05-21 39/week @ 2025-05-28 32/week @ 2025-06-04

201 downloads per month
Used in 2 crates (via blockfrost)

Apache-2.0

1.5MB
5K SLoC

Rust API client for openapi

Blockfrost is an API as a service that allows users to interact with the Cardano blockchain and parts of its ecosystem.

Tokens

After signing up on https://blockfrost.io, a project_id token is automatically generated for each project. HTTP header of your request MUST include this project_id in order to authenticate against Blockfrost servers.

Available networks

At the moment, you can use the following networks. Please, note that each network has its own project_id.

Network Endpoint
Cardano mainnet https://cardano-mainnet.blockfrost.io/api/v0
Cardano preprod https://cardano-preprod.blockfrost.io/api/v0
Cardano preview https://cardano-preview.blockfrost.io/api/v0
InterPlanetary File System https://ipfs.blockfrost.io/api/v0
Milkomeda mainnet https://milkomeda-mainnet.blockfrost.io/api/v0
Milkomeda testnet https://milkomeda-testnet.blockfrost.io/api/v0

Milkomeda

For more information about how to use Milkomeda as well as the list of available endpoints, see the Milkomeda section.

Concepts

  • All endpoints return either a JSON object or an array.
  • Data is returned in ascending (oldest first, newest last) order, if not stated otherwise.
    • You might use the ?order=desc query parameter to reverse this order.
  • By default, we return 100 results at a time. You have to use ?page=2 to list through the results.
  • All time and timestamp related fields (except server_time) are in seconds of UNIX time.
  • All amounts are returned in Lovelaces, where 1 ADA = 1 000 000 Lovelaces.
  • Addresses, accounts and pool IDs are in Bech32 format.
  • All values are case sensitive.
  • All hex encoded values are lower case.
  • Examples are not based on real data. Any resemblance to actual events is purely coincidental.
  • We allow to upload files up to 100MB of size to IPFS. This might increase in the future.
  • Only pinned IPFS files are counted towards the IPFS quota.
  • Non-pinned IPFS files are subject to regular garbage collection and will be removed unless pinned.
  • We allow maximum of 100 queued pins per IPFS user.

Errors

HTTP Status codes

The following are HTTP status code your application might receive when reaching Blockfrost endpoints and it should handle all of these cases.

  • HTTP 400 return code is used when the request is not valid.
  • HTTP 402 return code is used when the projects exceed their daily request limit.
  • HTTP 403 return code is used when the request is not authenticated.
  • HTTP 404 return code is used when the resource doesn't exist.
  • HTTP 418 return code is used when the user has been auto-banned for flooding too much after previously receiving error code 402 or 429.
  • HTTP 425 return code is used in Cardano networks, when the user has submitted a transaction when the mempool is already full, not accepting new txs straight away.
  • HTTP 425 return code is used in IPFS network, when the user has submitted a pin when the pin queue is already full, not accepting new pins straight away.
  • HTTP 429 return code is used when the user has sent too many requests in a given amount of time and therefore has been rate-limited.
  • HTTP 500 return code is used when our endpoints are having a problem.

Error codes

An internal error code number is used for better indication of the error in question. It is passed using the following payload.

{
  \"status_code\": 403,
  \"error\": \"Forbidden\",
  \"message\": \"Invalid project token.\"
}

Limits

There are two types of limits we are enforcing:

The first depends on your plan and is the number of request we allow per day. We defined the day from midnight to midnight of UTC time.

The second is rate limiting. We limit an end user, distinguished by IP address, to 10 requests per second. On top of that, we allow each user to send burst of 500 requests, which cools off at rate of 10 requests per second. In essence, a user is allowed to make another whole burst after (currently) 500/10 = 50 seconds. E.g. if a user attempts to make a call 3 seconds after whole burst, 30 requests will be processed. We believe this should be sufficient for most of the use cases. If it is not and you have a specific use case, please get in touch with us, and we will make sure to take it into account as much as we can.

SDKs

We support a number of SDKs that will help you in developing your application on top of Blockfrost.

Programming language SDK
JavaScript blockfrost-js
Haskell blockfrost-haskell
Python blockfrost-python
Rust blockfrost-rust
Golang blockfrost-go
Ruby blockfrost-ruby
Java blockfrost-java
Scala blockfrost-scala
Swift blockfrost-swift
Kotlin blockfrost-kotlin
Elixir blockfrost-elixir
.NET blockfrost-dotnet
Arduino blockfrost-arduino
PHP blockfrost-php
Crystal blockfrost-crystal

For more information, please visit https://blockfrost.io

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.75
  • Package version: 0.1.75
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to https://cardano-mainnet.blockfrost.io/api/v0

Class Method HTTP request Description
CardanoAccountsApi accounts_stake_address_addresses_assets_get GET /accounts/{stake_address}/addresses/assets Assets associated with the account addresses
CardanoAccountsApi accounts_stake_address_addresses_get GET /accounts/{stake_address}/addresses Account associated addresses
CardanoAccountsApi accounts_stake_address_addresses_total_get GET /accounts/{stake_address}/addresses/total Detailed information about account associated addresses
CardanoAccountsApi accounts_stake_address_delegations_get GET /accounts/{stake_address}/delegations Account delegation history
CardanoAccountsApi accounts_stake_address_get GET /accounts/{stake_address} Specific account address
CardanoAccountsApi accounts_stake_address_history_get GET /accounts/{stake_address}/history Account history
CardanoAccountsApi accounts_stake_address_mirs_get GET /accounts/{stake_address}/mirs Account MIR history
CardanoAccountsApi accounts_stake_address_registrations_get GET /accounts/{stake_address}/registrations Account registration history
CardanoAccountsApi accounts_stake_address_rewards_get GET /accounts/{stake_address}/rewards Account reward history
CardanoAccountsApi accounts_stake_address_utxos_get GET /accounts/{stake_address}/utxos Account UTXOs
CardanoAccountsApi accounts_stake_address_withdrawals_get GET /accounts/{stake_address}/withdrawals Account withdrawal history
CardanoAddressesApi addresses_address_extended_get GET /addresses/{address}/extended Extended information of a specific address
CardanoAddressesApi addresses_address_get GET /addresses/{address} Specific address
CardanoAddressesApi addresses_address_total_get GET /addresses/{address}/total Address details
CardanoAddressesApi addresses_address_transactions_get GET /addresses/{address}/transactions Address transactions
CardanoAddressesApi addresses_address_txs_get GET /addresses/{address}/txs Address txs
CardanoAddressesApi addresses_address_utxos_asset_get GET /addresses/{address}/utxos/{asset} Address UTXOs of a given asset
CardanoAddressesApi addresses_address_utxos_get GET /addresses/{address}/utxos Address UTXOs
CardanoAssetsApi assets_asset_addresses_get GET /assets/{asset}/addresses Asset addresses
CardanoAssetsApi assets_asset_get GET /assets/{asset} Specific asset
CardanoAssetsApi assets_asset_history_get GET /assets/{asset}/history Asset history
CardanoAssetsApi assets_asset_transactions_get GET /assets/{asset}/transactions Asset transactions
CardanoAssetsApi assets_asset_txs_get GET /assets/{asset}/txs Asset txs
CardanoAssetsApi assets_get GET /assets Assets
CardanoAssetsApi assets_policy_policy_id_get GET /assets/policy/{policy_id} Assets of a specific policy
CardanoBlocksApi blocks_epoch_epoch_number_slot_slot_number_get GET /blocks/epoch/{epoch_number}/slot/{slot_number} Specific block in a slot in an epoch
CardanoBlocksApi blocks_hash_or_number_addresses_get GET /blocks/{hash_or_number}/addresses Addresses affected in a specific block
CardanoBlocksApi blocks_hash_or_number_get GET /blocks/{hash_or_number} Specific block
CardanoBlocksApi blocks_hash_or_number_next_get GET /blocks/{hash_or_number}/next Listing of next blocks
CardanoBlocksApi blocks_hash_or_number_previous_get GET /blocks/{hash_or_number}/previous Listing of previous blocks
CardanoBlocksApi blocks_hash_or_number_txs_cbor_get GET /blocks/{hash_or_number}/txs/cbor Block transactions with CBOR data
CardanoBlocksApi blocks_hash_or_number_txs_get GET /blocks/{hash_or_number}/txs Block transactions
CardanoBlocksApi blocks_latest_get GET /blocks/latest Latest block
CardanoBlocksApi blocks_latest_txs_cbor_get GET /blocks/latest/txs/cbor Latest block transactions with CBOR data
CardanoBlocksApi blocks_latest_txs_get GET /blocks/latest/txs Latest block transactions
CardanoBlocksApi blocks_slot_slot_number_get GET /blocks/slot/{slot_number} Specific block in a slot
CardanoEpochsApi epochs_latest_get GET /epochs/latest Latest epoch
CardanoEpochsApi epochs_latest_parameters_get GET /epochs/latest/parameters Latest epoch protocol parameters
CardanoEpochsApi epochs_number_blocks_get GET /epochs/{number}/blocks Block distribution
CardanoEpochsApi epochs_number_blocks_pool_id_get GET /epochs/{number}/blocks/{pool_id} Block distribution by pool
CardanoEpochsApi epochs_number_get GET /epochs/{number} Specific epoch
CardanoEpochsApi epochs_number_next_get GET /epochs/{number}/next Listing of next epochs
CardanoEpochsApi epochs_number_parameters_get GET /epochs/{number}/parameters Protocol parameters
CardanoEpochsApi epochs_number_previous_get GET /epochs/{number}/previous Listing of previous epochs
CardanoEpochsApi epochs_number_stakes_get GET /epochs/{number}/stakes Stake distribution
CardanoEpochsApi epochs_number_stakes_pool_id_get GET /epochs/{number}/stakes/{pool_id} Stake distribution by pool
CardanoGovernanceApi governance_dreps_drep_id_delegators_get GET /governance/dreps/{drep_id}/delegators DRep delegators
CardanoGovernanceApi governance_dreps_drep_id_get GET /governance/dreps/{drep_id} Specific DRep
CardanoGovernanceApi governance_dreps_drep_id_metadata_get GET /governance/dreps/{drep_id}/metadata DRep metadata
CardanoGovernanceApi governance_dreps_drep_id_updates_get GET /governance/dreps/{drep_id}/updates DRep updates
CardanoGovernanceApi governance_dreps_drep_id_votes_get GET /governance/dreps/{drep_id}/votes DRep votes
CardanoGovernanceApi governance_dreps_get GET /governance/dreps Delegate Representatives (DReps)
CardanoGovernanceApi governance_proposals_get GET /governance/proposals Proposals
CardanoGovernanceApi governance_proposals_tx_hash_cert_index_get GET /governance/proposals/{tx_hash}/{cert_index} Specific proposal
CardanoGovernanceApi governance_proposals_tx_hash_cert_index_metadata_get GET /governance/proposals/{tx_hash}/{cert_index}/metadata Specific proposal metadata
CardanoGovernanceApi governance_proposals_tx_hash_cert_index_parameters_get GET /governance/proposals/{tx_hash}/{cert_index}/parameters Specific parameters proposal
CardanoGovernanceApi governance_proposals_tx_hash_cert_index_votes_get GET /governance/proposals/{tx_hash}/{cert_index}/votes Proposal votes
CardanoGovernanceApi governance_proposals_tx_hash_cert_index_withdrawals_get GET /governance/proposals/{tx_hash}/{cert_index}/withdrawals Specific withdrawals proposal
CardanoLedgerApi genesis_get GET /genesis Blockchain genesis
CardanoMempoolApi mempool_addresses_address_get GET /mempool/addresses/{address} Mempool by address
CardanoMempoolApi mempool_get GET /mempool Mempool
CardanoMempoolApi mempool_hash_get GET /mempool/{hash} Specific transaction in the mempool
CardanoMetadataApi metadata_txs_labels_get GET /metadata/txs/labels Transaction metadata labels
CardanoMetadataApi metadata_txs_labels_label_cbor_get GET /metadata/txs/labels/{label}/cbor Transaction metadata content in CBOR
CardanoMetadataApi metadata_txs_labels_label_get GET /metadata/txs/labels/{label} Transaction metadata content in JSON
CardanoNetworkApi network_eras_get GET /network/eras Query summary of blockchain eras
CardanoNetworkApi network_get GET /network Network information
CardanoPoolsApi pools_extended_get GET /pools/extended List of stake pools with additional information
CardanoPoolsApi pools_get GET /pools List of stake pools
CardanoPoolsApi pools_pool_id_blocks_get GET /pools/{pool_id}/blocks Stake pool blocks
CardanoPoolsApi pools_pool_id_delegators_get GET /pools/{pool_id}/delegators Stake pool delegators
CardanoPoolsApi pools_pool_id_get GET /pools/{pool_id} Specific stake pool
CardanoPoolsApi pools_pool_id_history_get GET /pools/{pool_id}/history Stake pool history
CardanoPoolsApi pools_pool_id_metadata_get GET /pools/{pool_id}/metadata Stake pool metadata
CardanoPoolsApi pools_pool_id_relays_get GET /pools/{pool_id}/relays Stake pool relays
CardanoPoolsApi pools_pool_id_updates_get GET /pools/{pool_id}/updates Stake pool updates
CardanoPoolsApi pools_pool_id_votes_get GET /pools/{pool_id}/votes Stake pool votes
CardanoPoolsApi pools_retired_get GET /pools/retired List of retired stake pools
CardanoPoolsApi pools_retiring_get GET /pools/retiring List of retiring stake pools
CardanoScriptsApi scripts_datum_datum_hash_cbor_get GET /scripts/datum/{datum_hash}/cbor Datum CBOR value
CardanoScriptsApi scripts_datum_datum_hash_get GET /scripts/datum/{datum_hash} Datum value
CardanoScriptsApi scripts_get GET /scripts Scripts
CardanoScriptsApi scripts_script_hash_cbor_get GET /scripts/{script_hash}/cbor Script CBOR
CardanoScriptsApi scripts_script_hash_get GET /scripts/{script_hash} Specific script
CardanoScriptsApi scripts_script_hash_json_get GET /scripts/{script_hash}/json Script JSON
CardanoScriptsApi scripts_script_hash_redeemers_get GET /scripts/{script_hash}/redeemers Redeemers of a specific script
CardanoTransactionsApi tx_submit_post POST /tx/submit Submit a transaction
CardanoTransactionsApi txs_hash_cbor_get GET /txs/{hash}/cbor Transaction CBOR
CardanoTransactionsApi txs_hash_delegations_get GET /txs/{hash}/delegations Transaction delegation certificates
CardanoTransactionsApi txs_hash_get GET /txs/{hash} Specific transaction
CardanoTransactionsApi txs_hash_metadata_cbor_get GET /txs/{hash}/metadata/cbor Transaction metadata in CBOR
CardanoTransactionsApi txs_hash_metadata_get GET /txs/{hash}/metadata Transaction metadata
CardanoTransactionsApi txs_hash_mirs_get GET /txs/{hash}/mirs Transaction MIRs
CardanoTransactionsApi txs_hash_pool_retires_get GET /txs/{hash}/pool_retires Transaction stake pool retirement certificates
CardanoTransactionsApi txs_hash_pool_updates_get GET /txs/{hash}/pool_updates Transaction stake pool registration and update certificates
CardanoTransactionsApi txs_hash_redeemers_get GET /txs/{hash}/redeemers Transaction redeemers
CardanoTransactionsApi txs_hash_required_signers_get GET /txs/{hash}/required_signers Transaction required signers
CardanoTransactionsApi txs_hash_stakes_get GET /txs/{hash}/stakes Transaction stake addresses certificates
CardanoTransactionsApi txs_hash_utxos_get GET /txs/{hash}/utxos Transaction UTXOs
CardanoTransactionsApi txs_hash_withdrawals_get GET /txs/{hash}/withdrawals Transaction withdrawal
CardanoUtilitiesApi utils_addresses_xpub_xpub_role_index_get GET /utils/addresses/xpub/{xpub}/{role}/{index} Derive an address
CardanoUtilitiesApi utils_txs_evaluate_post POST /utils/txs/evaluate Submit a transaction for execution units evaluation
CardanoUtilitiesApi utils_txs_evaluate_utxos_post POST /utils/txs/evaluate/utxos Submit a transaction for execution units evaluation (additional UTXO set)
HealthApi health_clock_get GET /health/clock Current backend time
HealthApi health_get GET /health Backend health status
HealthApi root_get GET / Root endpoint
IpfsAddApi ipfs_add POST /ipfs/add Add a file to IPFS
IpfsGatewayApi ipfs_gateway_ipfs_path_get GET /ipfs/gateway/{IPFS_path} Relay to an IPFS gateway
IpfsPinsApi ipfs_pin_add_ipfs_path_post POST /ipfs/pin/add/{IPFS_path} Pin an object
IpfsPinsApi ipfs_pin_list_get GET /ipfs/pin/list List pinned objects
IpfsPinsApi ipfs_pin_list_ipfs_path_get GET /ipfs/pin/list/{IPFS_path} Get details about pinned object
IpfsPinsApi ipfs_pin_remove_ipfs_path_post POST /ipfs/pin/remove/{IPFS_path} Remove a IPFS pin
MetricsApi metrics_endpoints_get GET /metrics/endpoints Blockfrost endpoint usage metrics
MetricsApi metrics_get GET /metrics Blockfrost usage metrics
NutLinkApi nutlink_address_get GET /nutlink/{address} Specific nut.link address
NutLinkApi nutlink_address_tickers_get GET /nutlink/{address}/tickers List of tickers of an oracle
NutLinkApi nutlink_address_tickers_ticker_get GET /nutlink/{address}/tickers/{ticker} Specific ticker for an address
NutLinkApi nutlink_tickers_ticker_get GET /nutlink/tickers/{ticker} Specific ticker

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

contact@blockfrost.io

Dependencies

~4.5–6MB
~114K SLoC