Blockfrost
Documentation Powered by ReDoc

Blockfrost.io ~ API Documentation (0.1.26)

Download OpenAPI specification:Download

Blockfrost Team: contact@blockfrost.io URL: https://blockfrost.io License: MIT Terms of Service

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.

NetworkEndpoint
Cardano mainnethttps://cardano-mainnet.blockfrost.io/api/v0
Cardano testnethttps://cardano-testnet.blockfrost.io/api/v0
InterPlanetary File Systemhttps://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.
    • 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.

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 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 attemtps 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 languageSDK
JavaScriptblockfrost-js

Authentication

ApiKeyAuth

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

Security Scheme Type API Key
Header parameter name: project_id

Health

Root endpoint

Root endpoint has no other function than to point end users to documentation.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{}

Backend health status

Return backend status as a boolean. Your application should handle situations when backend for the given chain is unavailable.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "is_healthy": true
}

Current backend time

This endpoint provides the current UNIX time. Your application might use this to verify if the client clock is not out of sync.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "server_time": 1603400958947
}

Metrics

Blockfrost usage metrics

History of your Blockfrost usage metrics in the past 30 days.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Blockfrost endpoint usage metrics

History of your Blockfrost usage metrics per endpoint in the past 30 days.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Cardano » Accounts

Specific account address

Obtain information about a specific stake account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

Responses

Response samples

Content type
application/json
{
  • "stake_address": "stake1ux3g2c9dx2nhhehyrezyxpkstartcqmu9hk63qgfkccw5rqttygt7",
  • "active": true,
  • "active_epoch": 412,
  • "controlled_amount": "619154618165",
  • "rewards_sum": "319154618165",
  • "withdrawals_sum": "12125369253",
  • "reserves_sum": "319154618165",
  • "treasury_sum": "12000000",
  • "withdrawable_amount": "319154618165",
  • "pool_id": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy"
}

Account reward history

Obtain information about the reward history of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Account history

Obtain information about the history of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Account delegation history

Obtain information about the delegation of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Account registration history

Obtain information about the registrations and deregistrations of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Account withdrawal history

Obtain information about the withdrawals of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Account MIR history

Obtain information about the MIRs of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Account associated addresses

Obtain information about the addresses of a specific account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Assets associated with the account addresses

Obtain information about assets associated with addresses of a specific account.

Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.

Authorizations:
ApiKeyAuth
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Cardano » Addresses

Specific address

Obtain information about a specific address.

Authorizations:
ApiKeyAuth
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

Responses

Response samples

Content type
application/json
{
  • "address": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz",
  • "amount": [
    ],
  • "stake_address": "stake1ux3g2c9dx2nhhehyrezyxpkstartcqmu9hk63qgfkccw5rqttygt7",
  • "type": "shelley"
}

Address details

Obtain details about an address.

Authorizations:
ApiKeyAuth
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

Responses

Response samples

Content type
application/json
{
  • "address": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz",
  • "received_sum": [
    ],
  • "sent_sum": [
    ],
  • "tx_count": 12
}

Address UTXOs

UTXOs of the address.

Authorizations:
ApiKeyAuth
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

Ordered by tx index in the block. The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Address transactions Deprecated

Transactions on the address.

Authorizations:
ApiKeyAuth
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer <= 100
Default: 100

The number of transactions per page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531",
  • "1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dde628516157f0"
]

Address transactions

Transactions on the address.

Authorizations:
ApiKeyAuth
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer <= 100
Default: 100

The numbers of pools per page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

from
string
Example: from=8929261

The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. Has to be lower than or equal to to parameter.

to
string
Example: to=9999269:10

The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. Has to be higher than or equal to from parameter.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Cardano » Assets

Assets

List of assets.

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Specific asset

Information about a specific asset

Authorizations:
ApiKeyAuth
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

Responses

Response samples

Content type
application/json
{
  • "asset": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e",
  • "policy_id": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a7",
  • "asset_name": "6e7574636f696e",
  • "fingerprint": "asset1pkpwyknlvul7az0xx8czhl60pyel45rpje4z8w",
  • "quantity": "12000",
  • "initial_mint_tx_hash": "6804edf9712d2b619edb6ac86861fe93a730693183a262b165fcc1ba1bc99cad",
  • "mint_or_burn_count": 1,
  • "onchain_metadata": {
    },
  • "metadata": {
    }
}

Asset history

History of a specific asset

Authorizations:
ApiKeyAuth
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Asset transactions Deprecated

List of a specific asset transactions

Authorizations:
ApiKeyAuth
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "8788591983aa73981fc92d6cddbbe643959f5a784e84b8bee0db15823f575a5b",
  • "52e748c4dec58b687b90b0b40d383b9fe1f24c1a833b7395cdf07dd67859f46f",
  • "e8073fd5318ff43eca18a852527166aa8008bee9ee9e891f585612b7e4ba700b"
]

Asset transactions

List of a specific asset transactions

Authorizations:
ApiKeyAuth
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Asset addresses

List of a addresses containing a specific asset

Authorizations:
ApiKeyAuth
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Assets of a specific policy

List of asset minted under a specific policy

Authorizations:
ApiKeyAuth
path Parameters
policy_id
required
string
Example: 476039a0949cf0b22f6a800f56780184c44533887ca6e821007840c3

Specific policy_id

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Cardano » Blocks

Latest block

Return the latest block available to the backends, also known as the tip of the blockchain.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "time": 1641338934,
  • "height": 15243593,
  • "hash": "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a",
  • "slot": 412162133,
  • "epoch": 425,
  • "epoch_slot": 12,
  • "slot_leader": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy",
  • "size": 3,
  • "tx_count": 1,
  • "output": "128314491794",
  • "fees": "592661",
  • "block_vrf": "vrf_vk1wf2k6lhujezqcfe00l6zetxpnmh9n6mwhpmhm0dvfh3fxgmdnrfqkms8ty",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Latest block transactions

Return the transactions within the latest block.

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

Ordered by tx index in the block. The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "8788591983aa73981fc92d6cddbbe643959f5a784e84b8bee0db15823f575a5b",
  • "4eef6bb7755d8afbeac526b799f3e32a624691d166657e9d862aaeb66682c036",
  • "52e748c4dec58b687b90b0b40d383b9fe1f24c1a833b7395cdf07dd67859f46f",
  • "e8073fd5318ff43eca18a852527166aa8008bee9ee9e891f585612b7e4ba700b"
]

Specific block

Return the content of a requested block.

Authorizations:
ApiKeyAuth
path Parameters
hash_or_number
required
string <64-character case-sensitive hexadecimal string or block number.>
Example: 4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a

Hash or number of the requested block.

Responses

Response samples

Content type
application/json
{
  • "time": 1641338934,
  • "height": 15243593,
  • "hash": "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a",
  • "slot": 412162133,
  • "epoch": 425,
  • "epoch_slot": 12,
  • "slot_leader": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy",
  • "size": 3,
  • "tx_count": 1,
  • "output": "128314491794",
  • "fees": "592661",
  • "block_vrf": "vrf_vk1wf2k6lhujezqcfe00l6zetxpnmh9n6mwhpmhm0dvfh3fxgmdnrfqkms8ty",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Specific block in a slot

Return the content of a requested block for a specific slot.

Authorizations:
ApiKeyAuth
path Parameters
slot_number
required
integer <slot number>
Example: 30895909

Slot position for requested block.

Responses

Response samples

Content type
application/json
{
  • "time": 1641338934,
  • "height": 15243593,
  • "hash": "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a",
  • "slot": 412162133,
  • "epoch": 425,
  • "epoch_slot": 12,
  • "slot_leader": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy",
  • "size": 3,
  • "tx_count": 1,
  • "output": "128314491794",
  • "fees": "592661",
  • "block_vrf": "vrf_vk1wf2k6lhujezqcfe00l6zetxpnmh9n6mwhpmhm0dvfh3fxgmdnrfqkms8ty",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Specific block in a slot in an epoch

Return the content of a requested block for a specific slot in an epoch.

Authorizations:
ApiKeyAuth
path Parameters
epoch_number
required
integer <slot number>
Example: 219

Epoch for specific epoch slot.

slot_number
required
integer <slot number>
Example: 30895909

Slot position for requested block.

Responses

Response samples

Content type
application/json
{
  • "time": 1641338934,
  • "height": 15243593,
  • "hash": "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a",
  • "slot": 412162133,
  • "epoch": 425,
  • "epoch_slot": 12,
  • "slot_leader": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy",
  • "size": 3,
  • "tx_count": 1,
  • "output": "128314491794",
  • "fees": "592661",
  • "block_vrf": "vrf_vk1wf2k6lhujezqcfe00l6zetxpnmh9n6mwhpmhm0dvfh3fxgmdnrfqkms8ty",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Listing of next blocks

Return the list of blocks following a specific block.

Authorizations:
ApiKeyAuth
path Parameters
hash_or_number
required
string <64-character case-sensitive hexadecimal string or block number.>
Example: 5ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a

Hash of the requested block.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listing of previous blocks

Return the list of blocks preceding a specific block.

Authorizations:
ApiKeyAuth
path Parameters
hash_or_number
required
string <64-character case-sensitive hexadecimal string or block number.>
Example: 4873401

Hash of the requested block

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Block transactions

Return the transactions within the block.

Authorizations:
ApiKeyAuth
path Parameters
hash_or_number
required
string <64-character case-sensitive hexadecimal string or block number.>
Example: 4873401

Hash of the requested block.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

Ordered by tx index in the block. The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "8788591983aa73981fc92d6cddbbe643959f5a784e84b8bee0db15823f575a5b",
  • "4eef6bb7755d8afbeac526b799f3e32a624691d166657e9d862aaeb66682c036",
  • "52e748c4dec58b687b90b0b40d383b9fe1f24c1a833b7395cdf07dd67859f46f",
  • "e8073fd5318ff43eca18a852527166aa8008bee9ee9e891f585612b7e4ba700b"
]

Cardano » Epochs

Latest epoch

Return the information about the latest, therefore current, epoch.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "epoch": 225,
  • "start_time": 1603403091,
  • "end_time": 1603835086,
  • "first_block_time": 1603403092,
  • "last_block_time": 1603835084,
  • "block_count": 21298,
  • "tx_count": 17856,
  • "output": "7849943934049314",
  • "fees": "4203312194",
  • "active_stake": "784953934049314"
}

Latest epoch protocol parameters

Return the protocol parameters for the latest epoch.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "epoch": 225,
  • "min_fee_a": 44,
  • "min_fee_b": 155381,
  • "max_block_size": 65536,
  • "max_tx_size": 16384,
  • "max_block_header_size": 1100,
  • "key_deposit": "2000000",
  • "pool_deposit": "500000000",
  • "e_max": 18,
  • "n_opt": 150,
  • "a0": 0.3,
  • "rho": 0.003,
  • "tau": 0.2,
  • "decentralisation_param": 0.5,
  • "extra_entropy": null,
  • "protocol_major_ver": 2,
  • "protocol_minor_ver": 0,
  • "min_utxo": "1000000",
  • "min_pool_cost": "340000000",
  • "nonce": "1a3be38bcbb7911969283716ad7aa550250226b76a61fc51cc9a9a35d9276d81"
}

Specific epoch

Return the content of the requested epoch.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

Responses

Response samples

Content type
application/json
{
  • "epoch": 225,
  • "start_time": 1603403091,
  • "end_time": 1603835086,
  • "first_block_time": 1603403092,
  • "last_block_time": 1603835084,
  • "block_count": 21298,
  • "tx_count": 17856,
  • "output": "7849943934049314",
  • "fees": "4203312194",
  • "active_stake": "784953934049314"
}

Listing of next epochs

Return the list of epochs following a specific epoch.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the requested epoch.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listing of previous epochs

Return the list of epochs preceding a specific epoch.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stake distribution

Return the active stake distribution for the specified epoch.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stake distribution by pool

Return the active stake distribution for the epoch specified by stake pool.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Stake pool ID to filter

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Block distribution

Return the blocks minted for the epoch specified.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "d0fa315687e99ccdc96b14cc2ea74a767405d64427b648c470731a9b69e4606e",
  • "38bc6efb92a830a0ed22a64f979d120d26483fd3c811f6622a8c62175f530878",
  • "f3258fcd8b975c061b4fcdcfcbb438807134d6961ec278c200151274893b6b7d"
]

Block distribution

Return the block minted for the epoch specified by stake pool.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Stake pool ID to filter

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "d0fa315687e99ccdc96b14cc2ea74a767405d64427b648c470731a9b69e4606e",
  • "38bc6efb92a830a0ed22a64f979d120d26483fd3c811f6622a8c62175f530878",
  • "f3258fcd8b975c061b4fcdcfcbb438807134d6961ec278c200151274893b6b7d"
]

Protocol parameters

Return the protocol parameters for the epoch specified.

Authorizations:
ApiKeyAuth
path Parameters
number
required
integer
Example: 225

Number of the epoch

Responses

Response samples

Content type
application/json
{
  • "epoch": 225,
  • "min_fee_a": 44,
  • "min_fee_b": 155381,
  • "max_block_size": 65536,
  • "max_tx_size": 16384,
  • "max_block_header_size": 1100,
  • "key_deposit": "2000000",
  • "pool_deposit": "500000000",
  • "e_max": 18,
  • "n_opt": 150,
  • "a0": 0.3,
  • "rho": 0.003,
  • "tau": 0.2,
  • "decentralisation_param": 0.5,
  • "extra_entropy": null,
  • "protocol_major_ver": 2,
  • "protocol_minor_ver": 0,
  • "min_utxo": "1000000",
  • "min_pool_cost": "340000000",
  • "nonce": "1a3be38bcbb7911969283716ad7aa550250226b76a61fc51cc9a9a35d9276d81"
}

Cardano » Ledger

Blockchain genesis

Return the information about blockchain genesis.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "active_slots_coefficient": 0.05,
  • "update_quorum": 5,
  • "max_lovelace_supply": "45000000000000000",
  • "network_magic": 764824073,
  • "epoch_length": 432000,
  • "system_start": 1506203091,
  • "slots_per_kes_period": 129600,
  • "slot_length": 1,
  • "max_kes_evolutions": 62,
  • "security_param": 2160
}

Cardano » Metadata

Transaction metadata labels

List of all used transaction metadata labels.

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Transaction metadata content in JSON

Transaction metadata per label.

Authorizations:
ApiKeyAuth
path Parameters
label
required
string
Example: 1990

Metadata label

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Transaction metadata content in CBOR

Transaction metadata per label.

Authorizations:
ApiKeyAuth
path Parameters
label
required
string
Example: 1990

Metadata label

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Cardano » Network

Network information

Return detailed network information.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "supply": {
    },
  • "stake": {
    }
}

Cardano » Pools

List of stake pools

List of registered stake pools.

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The numbers of pools per page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy",
  • "pool1hn7hlwrschqykupwwrtdfkvt2u4uaxvsgxyh6z63703p2knj288",
  • "pool1ztjyjfsh432eqetadf82uwuxklh28xc85zcphpwq6mmezavzad2"
]

List of retired stake pools

List of already retired pools.

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The numbers of pools per page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

List of retiring stake pools

List of stake pools retiring in the upcoming epochs

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Specific stake pool

Pool information.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

Responses

Response samples

Content type
application/json
{
  • "pool_id": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy",
  • "hex": "0f292fcaa02b8b2f9b3c8f9fd8e0bb21abedb692a6d5058df3ef2735",
  • "vrf_key": "0b5245f9934ec2151116fb8ec00f35fd00e0aa3b075c4ed12cce440f999d8233",
  • "blocks_minted": 69,
  • "live_stake": "6900000000",
  • "live_size": 0.42,
  • "live_saturation": 0.93,
  • "live_delegators": 127,
  • "active_stake": "4200000000",
  • "active_size": 0.43,
  • "declared_pledge": "5000000000",
  • "live_pledge": "5000000001",
  • "margin_cost": 0.05,
  • "fixed_cost": "340000000",
  • "reward_account": "stake1uxkptsa4lkr55jleztw43t37vgdn88l6ghclfwuxld2eykgpgvg3f",
  • "owners": [
    ],
  • "registration": [
    ],
  • "retirement": [
    ]
}

Stake pool history

History of stake pool parameters over epochs.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stake pool metadata

Stake pool registration metadata.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

Responses

Response samples

Content type
application/json
Example
pool_metadata
pool_metadata
empty_object
{
  • "pool_id": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy",
  • "hex": "0f292fcaa02b8b2f9b3c8f9fd8e0bb21abedb692a6d5058df3ef2735",
  • "url": "https://stakenuts.com/mainnet.json",
  • "hash": "47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c",
  • "ticker": "NUTS",
  • "name": "Stake Nuts",
  • "description": "The best pool ever",
  • "homepage": "https://stakentus.com/"
}

Stake pool relays

Relays of a stake pool.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

Responses

Response samples

Content type
application/json
[]

Stake pool delegators

List of current stake pools delegators.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Stake pool blocks

List of stake pools blocks.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • "d8982ca42cfe76b747cc681d35d671050a9e41e9cfe26573eb214e94fe6ff21d",
  • "026436c539e2ce84c7f77ffe669f4e4bbbb3b9c53512e5857dcba8bb0b4e9a8c",
  • "bcc8487f419b8c668a18ea2120822a05df6dfe1de1f0fac3feba88cf760f303c",
  • "86bf7b4a274e0f8ec9816171667c1b4a0cfc661dc21563f271acea9482b62df7"
]

Stake pool updates

List of certificate updates to the stake pool.

Authorizations:
ApiKeyAuth
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Cardano » Transactions

Specific transaction

Return content of the requested transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string.>
Example: 6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction

Responses

Response samples

Content type
application/json
{
  • "hash": "1e043f100dce12d107f679685acd2fc0610e10f72a92d412794c9773d11d8477",
  • "block": "356b7d7dbb696ccd12775c016941057a9dc70898d87a63fc752271bb46856940",
  • "block_height": 123456,
  • "slot": 42000000,
  • "index": 1,
  • "output_amount": [
    ],
  • "fees": "182485",
  • "deposit": "0",
  • "size": 433,
  • "invalid_before": null,
  • "invalid_hereafter": "13885913",
  • "utxo_count": 4,
  • "withdrawal_count": 0,
  • "mir_cert_count": 0,
  • "delegation_count": 0,
  • "stake_cert_count": 0,
  • "pool_update_count": 0,
  • "pool_retire_count": 0,
  • "asset_mint_or_burn_count": 0
}

Transaction UTXOs

Return the inputs and UTXOs of the specific transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction

Responses

Response samples

Content type
application/json
{
  • "hash": "1e043f100dce12d107f679685acd2fc0610e10f72a92d412794c9773d11d8477",
  • "inputs": [
    ],
  • "outputs": [
    ]
}

Transaction stake addresses certificates

Obtain information about (de)registration of stake addresses within a transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string.>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction delegation certificates

Obtain information about delegation certificates of a specific transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction withdrawal

Obtain information about withdrawals of a specific transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction MIRs

Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction stake pool registration and update certificates

Obtain information about stake pool registration and update certificates of a specific transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction stake pool retirement certificates

Obtain information about stake pool retirements within a specific transaction.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string.>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction metadata

Obtain the transaction metadata.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string.>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Transaction metadata in CBOR

Obtain the transaction metadata in CBOR.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string <64-character case-sensitive hexadecimal string.>
Example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b

Hash of the requested transaction

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Submit a transaction

Submit an already serialized transaction to the network.

Authorizations:
ApiKeyAuth
header Parameters
Content-Type
required
string
Value: "application/cbor"

Responses

Request samples 

# Assuming `data` is a serialized transaction on the file-system.
curl "https://cardano-mainnet.blockfrost.io/api/v0/tx/submit" \
  -X POST \
  -H "Content-Type: application/cbor" \
  -H "project_id: $PROJECT_ID" \
  --data-binary @./data

Response samples

Content type
application/json
"d1662b24fa9fe985fc2dce47455df399cb2e31e1e1819339e885801cc3578908"

IPFS » Add

Add a file or directory to IPFS

You need to /ipfs/pin/add an object to avoid it being garbage collected. This usage is being counted in your user account quota.

Authorizations:
ApiKeyAuth

Responses

Request samples 

curl "https://ipfs.blockfrost.io/api/v0/ipfs/add" \
  -X POST \
  -H "project_id: $PROJECT_ID" \
  -F "file=@./README.md"

Response samples

Content type
application/json
{
  • "name": "README.md",
  • "ipfs_hash": "QmZbHqiCxKEVX7QfijzJTkZiSi3WEVTcvANgNAWzDYgZDr",
  • "size": "125297"
}

IPFS » Gateway

Relay to an IPFS gateway

Retrieve an object from the IFPS gateway (useful if you do not want to rely on a public gateway, such as ipfs.blockfrost.dev).

Authorizations:
ApiKeyAuth
path Parameters
IPFS_path
required
string

Path to the IPFS object

Responses

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "error": "Bad Request",
  • "message": "Backend did not understand your request."
}

IPFS » Pins

Pin an object

Pinned objects are counted in your user storage quota.

Authorizations:
ApiKeyAuth
path Parameters
IPFS_path
required
string

Path to the IPFS object

Responses

Response samples

Content type
application/json
{
  • "ipfs_hash": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8",
  • "state": "queued"
}

List pinned objects

List objects pinned to local storage

Authorizations:
ApiKeyAuth
query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get details about pinned object

Get information about locally pinned IPFS object

Authorizations:
ApiKeyAuth
path Parameters
IPFS_path
required
string

The path to the IPFS object

Responses

Response samples

Content type
application/json
{
  • "time_created": 1615551024,
  • "time_pinned": 1615551024,
  • "ipfs_hash": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx",
  • "size": "1615551024",
  • "state": "pinned"
}

Remove pinned objects from local storage

Remove pinned objects from local storage

Authorizations:
ApiKeyAuth
path Parameters
IPFS_path
required
string

The path to the IPFS object

Responses

Response samples

Content type
application/json
{
  • "ipfs_hash": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8",
  • "state": "unpinned"
}

List metadata about specific address

List metadata about specific address

Authorizations:
ApiKeyAuth
path Parameters
address
required
string

Address of a metadata oracle

Responses

Response samples

Content type
application/json
{
  • "address": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz",
  • "metadata_url": "https://nut.link/metadata.json",
  • "metadata_hash": "6bf124f217d0e5a0a8adb1dbd8540e1334280d49ab861127868339f43b3948af",
  • "metadata": { }
}

List tickers for a specific metadata oracle

List tickers for a specific metadata oracle

Authorizations:
ApiKeyAuth
path Parameters
address
required
string

Address of a metadata oracle

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

List of records of a specific ticker

List of records of a specific ticker

Authorizations:
ApiKeyAuth
path Parameters
address
required
string

Address of a metadata oracle

ticker
required
string

Ticker for the pool record

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of records of a specific ticker

List of records of a specific ticker

Authorizations:
ApiKeyAuth
path Parameters
ticker
required
string

Ticker for the pool record

query Parameters
count
integer <= 100
Default: 100

The number of results displayed on one page.

page
integer
Default: 1

The page number for listing the results.

order
string
Default: "asc"
Enum: "asc" "desc"

The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    }
]