# Table of Contents - [Blockfrost.io - Blockfrost Open API](#blockfrost-io-blockfrost-open-api) - [404: NOT_FOUND](#404-not-found) - [404: NOT_FOUND](#404-not-found) - [404: NOT_FOUND](#404-not-found) --- # Blockfrost.io - Blockfrost Open API v0.1.84 OAS 3.0.3 Blockfrost.io ~ API Documentation ================================= [Blockfrost Team](mailto:contact@blockfrost.io) [MIT](https://opensource.org/licenses/MIT) [Terms of Service](https://blockfrost.io/terms) Download OpenAPI Document json Download OpenAPI Document yaml 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](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` | 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](https://github.com/blockfrost/blockfrost-js) | | Haskell | [blockfrost-haskell](https://github.com/blockfrost/blockfrost-haskell) | | Python | [blockfrost-python](https://github.com/blockfrost/blockfrost-python) | | Rust | [blockfrost-rust](https://github.com/blockfrost/blockfrost-rust) | | Golang | [blockfrost-go](https://github.com/blockfrost/blockfrost-go) | | Ruby | [blockfrost-ruby](https://github.com/blockfrost/blockfrost-ruby) | | Java | [blockfrost-java](https://github.com/blockfrost/blockfrost-java) | | Scala | [blockfrost-scala](https://github.com/blockfrost/blockfrost-scala) | | Swift | [blockfrost-swift](https://github.com/blockfrost/blockfrost-swift) | | Kotlin | [blockfrost-kotlin](https://github.com/blockfrost/blockfrost-kotlin) | | Elixir | [blockfrost-elixir](https://github.com/blockfrost/blockfrost-elixir) | | .NET | [blockfrost-dotnet](https://github.com/blockfrost/blockfrost-dotnet) | | Arduino | [blockfrost-arduino](https://github.com/blockfrost/blockfrost-arduino) | | PHP | [blockfrost-php](https://github.com/blockfrost/blockfrost-php) | | Crystal | [blockfrost-crystal](https://github.com/blockfrost/blockfrost-crystal) | Server Server:https://cardano-mainnet.blockfrost.io/api/v0 Cardano Mainnet network AuthenticationRequired -------------------------- Selected Auth Type: 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.

More | | Name :

project\_id | | Value :

Show Password | Client Libraries Shell Ruby Node.js PHP Python More Select from all clients Shell Curl Health ------ ​Copy link Health Operations * get/ * get/health * get/health/clock ### Root endpoint ​Copy link Root endpoint has no other function than to point end users to documentation. Responses * 200 Information pointing to the documentation. application/json * 400 Bad request application/json * 403 Authentication secret is missing or invalid application/json * 418 IP has been auto-banned for extensive sending of requests after usage limit has been reached application/json * 429 Usage limit reached application/json * 500 Internal Server Error application/json Request Example for get/ Shell Curl curl https://cardano-mainnet.blockfrost.io/api/v0/ \ --header 'project_id: YOUR_SECRET_TOKEN' Test Request(get /) Status: 200Status: 400Status: 403Status: 418Status: 429Status: 500 Show Schema { "url": "https://blockfrost.io/", "version": "0.1.0" } Information pointing to the documentation. ### Backend health status ​Copy link Return backend status as a boolean. Your application should handle situations when backend for the given chain is unavailable. Responses * 200 Return the boolean indicating the health of the backend. application/json * 400 Bad request application/json * 403 Authentication secret is missing or invalid application/json * 418 IP has been auto-banned for extensive sending of requests after usage limit has been reached application/json * 429 Usage limit reached application/json * 500 Internal Server Error application/json Request Example for get/health Shell Curl curl https://cardano-mainnet.blockfrost.io/api/v0/health Test Request(get /health) Status: 200Status: 400Status: 403Status: 418Status: 429Status: 500 Show Schema { "is_healthy": true } Return the boolean indicating the health of the backend. ### Current backend time ​Copy link This endpoint provides the current UNIX time. Your application might use this to verify if the client clock is not out of sync. Responses * 200 Return the current UNIX time in milliseconds. application/json * 400 Bad request application/json * 403 Authentication secret is missing or invalid application/json * 418 IP has been auto-banned for extensive sending of requests after usage limit has been reached application/json * 429 Usage limit reached application/json * 500 Internal Server Error application/json Request Example for get/health/clock Shell Curl curl https://cardano-mainnet.blockfrost.io/api/v0/health/clock \ --header 'project_id: YOUR_SECRET_TOKEN' Test Request(get /health/clock) Status: 200Status: 400Status: 403Status: 418Status: 429Status: 500 Show Schema { "server_time": 1603400958947 } Return the current UNIX time in milliseconds. Metrics (Collapsed) ------------------- ​Copy link Metrics Operations * get/metrics * get/metrics/endpoints Show More Cardano » Accounts (Collapsed) ------------------------------ ​Copy link Cardano » Accounts Operations * get/accounts/{stake\_address} * get/accounts/{stake\_address}/rewards * get/accounts/{stake\_address}/history * get/accounts/{stake\_address}/delegations * get/accounts/{stake\_address}/registrations * get/accounts/{stake\_address}/withdrawals * get/accounts/{stake\_address}/mirs * get/accounts/{stake\_address}/addresses * get/accounts/{stake\_address}/addresses/assets * get/accounts/{stake\_address}/addresses/total * get/accounts/{stake\_address}/utxos * get/accounts/{stake\_address}/transactions Show More Cardano » Addresses (Collapsed) ------------------------------- ​Copy link Cardano » Addresses Operations * get/addresses/{address} * get/addresses/{address}/extended * get/addresses/{address}/total * get/addresses/{address}/utxos * get/addresses/{address}/utxos/{asset} * get/addresses/{address}/txs * get/addresses/{address}/transactions Show More Cardano » Assets (Collapsed) ---------------------------- ​Copy link Cardano » Assets Operations * get/assets * get/assets/{asset} * get/assets/{asset}/history * get/assets/{asset}/txs * get/assets/{asset}/transactions * get/assets/{asset}/addresses * get/assets/policy/{policy\_id} Show More Cardano » Blocks (Collapsed) ---------------------------- ​Copy link Cardano » Blocks Operations * get/blocks/latest * get/blocks/latest/txs * get/blocks/latest/txs/cbor * get/blocks/{hash\_or\_number} * get/blocks/{hash\_or\_number}/next * get/blocks/{hash\_or\_number}/previous * get/blocks/slot/{slot\_number} * get/blocks/epoch/{epoch\_number}/slot/{slot\_number} * get/blocks/{hash\_or\_number}/txs * get/blocks/{hash\_or\_number}/txs/cbor * get/blocks/{hash\_or\_number}/addresses Show More Cardano » Epochs (Collapsed) ---------------------------- ​Copy link Cardano » Epochs Operations * get/epochs/latest * get/epochs/latest/parameters * get/epochs/{number} * get/epochs/{number}/next * get/epochs/{number}/previous * get/epochs/{number}/stakes * get/epochs/{number}/stakes/{pool\_id} * get/epochs/{number}/blocks * get/epochs/{number}/blocks/{pool\_id} * get/epochs/{number}/parameters Show More Cardano » Governance (Collapsed) -------------------------------- ​Copy link Cardano » Governance Operations * get/governance/dreps * get/governance/dreps/{drep\_id} * get/governance/dreps/{drep\_id}/delegators * get/governance/dreps/{drep\_id}/metadata * get/governance/dreps/{drep\_id}/updates * get/governance/dreps/{drep\_id}/votes * get/governance/proposals * get/governance/proposals/{tx\_hash}/{cert\_index} * get/governance/proposals/{tx\_hash}/{cert\_index}/parameters * get/governance/proposals/{tx\_hash}/{cert\_index}/withdrawals * get/governance/proposals/{tx\_hash}/{cert\_index}/votes * get/governance/proposals/{tx\_hash}/{cert\_index}/metadata * get/governance/proposals/{gov\_action\_id} * get/governance/proposals/{gov\_action\_id}/parameters * get/governance/proposals/{gov\_action\_id}/withdrawals * get/governance/proposals/{gov\_action\_id}/votes * get/governance/proposals/{gov\_action\_id}/metadata Show More Cardano » Ledger (Collapsed) ---------------------------- ​Copy link Cardano » Ledger Operations * get/genesis Show More Cardano » Mempool (Collapsed) ----------------------------- ​Copy link Cardano » Mempool Operations * get/mempool * get/mempool/{hash} * get/mempool/addresses/{address} Show More Cardano » Metadata (Collapsed) ------------------------------ ​Copy link Cardano » Metadata Operations * get/metadata/txs/labels * get/metadata/txs/labels/{label} * get/metadata/txs/labels/{label}/cbor Show More Cardano » Network (Collapsed) ----------------------------- ​Copy link Cardano » Network Operations * get/network * get/network/eras Show More Cardano » Pools (Collapsed) --------------------------- ​Copy link Cardano » Pools Operations * get/pools * get/pools/extended * get/pools/retired * get/pools/retiring * get/pools/{pool\_id} * get/pools/{pool\_id}/history * get/pools/{pool\_id}/metadata * get/pools/{pool\_id}/relays * get/pools/{pool\_id}/delegators * get/pools/{pool\_id}/blocks * get/pools/{pool\_id}/updates * get/pools/{pool\_id}/votes Show More Cardano » Scripts (Collapsed) ----------------------------- ​Copy link Cardano » Scripts Operations * get/scripts * get/scripts/{script\_hash} * get/scripts/{script\_hash}/json * get/scripts/{script\_hash}/cbor * get/scripts/{script\_hash}/redeemers * get/scripts/datum/{datum\_hash} * get/scripts/datum/{datum\_hash}/cbor Show More Cardano » Transactions (Collapsed) ---------------------------------- ​Copy link Cardano » Transactions Operations * get/txs/{hash} * get/txs/{hash}/utxos * get/txs/{hash}/stakes * get/txs/{hash}/delegations * get/txs/{hash}/withdrawals * get/txs/{hash}/mirs * get/txs/{hash}/pool\_updates * get/txs/{hash}/pool\_retires * get/txs/{hash}/metadata * get/txs/{hash}/metadata/cbor * get/txs/{hash}/redeemers * get/txs/{hash}/required\_signers * get/txs/{hash}/cbor * post/tx/submit Show More Cardano » Utilities (Collapsed) ------------------------------- ​Copy link Cardano » Utilities Operations * get/utils/addresses/xpub/{xpub}/{role}/{index} * post/utils/txs/evaluate * post/utils/txs/evaluate/utxos Show More IPFS » Add (Collapsed) ---------------------- ​Copy link IPFS » Add Operations * post/ipfs/add Show More IPFS » Gateway (Collapsed) -------------------------- ​Copy link IPFS » Gateway Operations * get/ipfs/gateway/{IPFS\_path} Show More IPFS » Pins (Collapsed) ----------------------- ​Copy link IPFS » Pins Operations * post/ipfs/pin/add/{IPFS\_path} * get/ipfs/pin/list * get/ipfs/pin/list/{IPFS\_path} * post/ipfs/pin/remove/{IPFS\_path} Show More Nut.link (Collapsed) -------------------- ​Copy link Nut.link Operations * get/nutlink/{address} * get/nutlink/{address}/tickers * get/nutlink/{address}/tickers/{ticker} * get/nutlink/tickers/{ticker} Show More Show sidebar GET Server: https://cardano-mainnet.blockfrost.io/api/v0 / Send Send get request to https://cardano-mainnet.blockfrost.io/api/v0/ [Open API Client](https://client.scalar.com/?url=https%3A%2F%2Fdocs.blockfrost.io%2Fblockfrost-openapi.yaml&integration=html&utm_source=api-reference&utm_medium=button&utm_campaign=modal) Close ClientClose Client Root endpoint AllAuthCookiesHeadersQuery All AuthenticationRequired -------------------------- Selected Auth Type: 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. | | Name :

project\_id | | Value :

Show Password | Path Parameters --------------- Cookies ------- | Cookie Enabled | Cookie Key | Cookie Value | | --- | --- | --- | | | Key | Value | Headers ------- Clear All Headers | Header Enabled | Header Key | Header Value | | --- | --- | --- | | | Accept | \*/\* | | | Key | Value | Query Parameters ---------------- | Parameter Enabled | Parameter Key | Parameter Value | | --- | --- | --- | | | Key | Value | Code Snippet (Collapsed) ------------------------ Curl Response AllCookiesHeadersBody All [Powered By Scalar.com](https://www.scalar.com/) .,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........\` |||||!!-.\_ ||||.......;. ':!|||||||||!!-.\_ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;\`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........\` .b888888888886foi;:::::::::::::::::::::::..........\` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......\`!Tf998888888888888888888888888888888886foi;:::....\` '"^!|Tf9988888888888888888888888888888888!::..\` '"^!|Tf998888888888888888888888889!! '\` '"^!|Tf9988888888888888888!!\` iBBbo. '"^!|Tf998888888889!\` WBBBBbo. '"^!|Tf9989!\` YBBBP^' '"^!\` \` Send Request ctrlControl ↵Enter --- # 404: NOT_FOUND **404**: NOT\_FOUND Code: `NOT_FOUND` ID: `iad1::kvj9r-1766282938605-83e4c6c3605e` [Read our documentation to learn more about this error.](https://vercel.com/docs/errors/NOT_FOUND) --- # 404: NOT_FOUND **404**: NOT\_FOUND Code: `NOT_FOUND` ID: `iad1::kb4pg-1766282938648-4e6f8077b633` [Read our documentation to learn more about this error.](https://vercel.com/docs/errors/NOT_FOUND) --- # 404: NOT_FOUND **404**: NOT\_FOUND Code: `NOT_FOUND` ID: `iad1::8qjfr-1766282938665-1d133578a851` [Read our documentation to learn more about this error.](https://vercel.com/docs/errors/NOT_FOUND) ---