Blockfrost
API docs by Redocly

Blockfrost.io ~ API Documentation (0.1.65)

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.

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

Health

Root endpoint

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

Authorizations:
project_id

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.

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:
project_id

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:
project_id

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:
project_id

Responses

Response samples

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

Cardano » Accounts

Specific account address

Obtain information about a specific stake account.

Authorizations:
project_id
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",
  • "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc"
}

Account reward history

Obtain information about the reward history of a specific account.

Authorizations:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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. 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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
stake_address
required
string
Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc

Bech32 stake address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    },
  • {
    }
]

Detailed information about account associated addresses

Obtain summed details about all addresses associated with a given 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:
project_id
path Parameters
stake_address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

Responses

Response samples

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

Cardano » Addresses

Specific address

Obtain information about a specific address.

Authorizations:
project_id
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

Responses

Response samples

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

Extended information of a specific address

Obtain extended information about a specific address.

Authorizations:
project_id
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

Responses

Response samples

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

Address details

Obtain details about an address.

Authorizations:
project_id
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:
project_id
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    },
  • {
    },
  • {
    }
]

Address UTXOs of a given asset

UTXOs of the address.

Authorizations:
project_id
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    },
  • {
    },
  • {
    }
]

Address txs Deprecated

Transactions on the address.

Authorizations:
project_id
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of transactions per page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
address
required
string
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of addresses per page.

page
integer [ 1 .. 21474836 ]
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. If an asset is completely burned, it will stay on the list with quantity 0 (order of assets is immutable).

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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. Ordering in this case is based on the time of the first mint transaction.

Responses

Response samples

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

Specific asset

Information about a specific asset

Authorizations:
project_id
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": { },
  • "onchain_metadata_standard": "CIP25v1",
  • "onchain_metadata_extra": "string",
  • "metadata": {
    }
}

Asset history

History of a specific asset

Authorizations:
project_id
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 txs Deprecated

List of a specific asset transactions

Authorizations:
project_id
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
asset
required
string
Example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e

Concatenation of the policy_id and hex-encoded asset_name

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
policy_id
required
string
Example: 476039a0949cf0b22f6a800f56780184c44533887ca6e821007840c3

Specific policy_id

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id

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",
  • "op_cert": "da905277534faf75dae41732650568af545134ee08a3c0392dbefc8096ae177c",
  • "op_cert_counter": "18",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Latest block transactions

Return the transactions within the latest block.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
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",
  • "op_cert": "da905277534faf75dae41732650568af545134ee08a3c0392dbefc8096ae177c",
  • "op_cert_counter": "18",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Listing of next blocks

Return the list of blocks following a specific block.

Authorizations:
project_id
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 [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
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 [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
Default: 1

The page number for listing the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Specific block in a slot

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

Authorizations:
project_id
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",
  • "op_cert": "da905277534faf75dae41732650568af545134ee08a3c0392dbefc8096ae177c",
  • "op_cert_counter": "18",
  • "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:
project_id
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",
  • "op_cert": "da905277534faf75dae41732650568af545134ee08a3c0392dbefc8096ae177c",
  • "op_cert_counter": "18",
  • "previous_block": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05",
  • "next_block": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa",
  • "confirmations": 4698
}

Block transactions

Return the transactions within the block.

Authorizations:
project_id
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 [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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"
]

Addresses affected in a specific block

Return list of addresses affected in the specified block with additional information, sorted by the bech32 address, ascending.

Authorizations:
project_id
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 [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
Default: 1

The page number for listing the results.

Responses

Response samples

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

Cardano » Epochs

Latest epoch

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

Authorizations:
project_id

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:
project_id

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",
  • "cost_models": {
    },
  • "price_mem": 0.0577,
  • "price_step": 0.0000721,
  • "max_tx_ex_mem": "10000000",
  • "max_tx_ex_steps": "10000000000",
  • "max_block_ex_mem": "50000000",
  • "max_block_ex_steps": "40000000000",
  • "max_val_size": "5000",
  • "collateral_percent": 150,
  • "max_collateral_inputs": 3,
  • "coins_per_utxo_size": "34482",
  • "coins_per_utxo_word": "34482",
  • "pvt_motion_no_confidence": 0,
  • "pvt_committee_normal": 0,
  • "pvt_committee_no_confidence": 0,
  • "pvt_hard_fork_initiation": 0,
  • "dvt_motion_no_confidence": 0,
  • "dvt_committee_normal": 0,
  • "dvt_committee_no_confidence": 0,
  • "dvt_update_to_constitution": 0,
  • "dvt_hard_fork_initiation": 0,
  • "dvt_p_p_network_group": 0,
  • "dvt_p_p_economic_group": 0,
  • "dvt_p_p_technical_group": 0,
  • "dvt_p_p_gov_group": 0,
  • "dvt_treasury_withdrawal": 0,
  • "committee_min_size": "string",
  • "committee_max_term_length": "string",
  • "gov_action_lifetime": "string",
  • "gov_action_deposit": "string",
  • "drep_deposit": "string",
  • "drep_activity": "string",
  • "pvtpp_security_group": 0,
  • "min_fee_ref_script_cost_per_byte": 0
}

Specific epoch

Return the content of the requested epoch.

Authorizations:
project_id
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:
project_id
path Parameters
number
required
integer
Example: 225

Number of the requested epoch.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
number
required
integer
Example: 225

Number of the epoch

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
number
required
integer
Example: 225

Number of the epoch

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
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 [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
number
required
integer
Example: 225

Number of the epoch

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 by pool

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

Authorizations:
project_id
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 [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
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",
  • "cost_models": {
    },
  • "price_mem": 0.0577,
  • "price_step": 0.0000721,
  • "max_tx_ex_mem": "10000000",
  • "max_tx_ex_steps": "10000000000",
  • "max_block_ex_mem": "50000000",
  • "max_block_ex_steps": "40000000000",
  • "max_val_size": "5000",
  • "collateral_percent": 150,
  • "max_collateral_inputs": 3,
  • "coins_per_utxo_size": "34482",
  • "coins_per_utxo_word": "34482",
  • "pvt_motion_no_confidence": 0,
  • "pvt_committee_normal": 0,
  • "pvt_committee_no_confidence": 0,
  • "pvt_hard_fork_initiation": 0,
  • "dvt_motion_no_confidence": 0,
  • "dvt_committee_normal": 0,
  • "dvt_committee_no_confidence": 0,
  • "dvt_update_to_constitution": 0,
  • "dvt_hard_fork_initiation": 0,
  • "dvt_p_p_network_group": 0,
  • "dvt_p_p_economic_group": 0,
  • "dvt_p_p_technical_group": 0,
  • "dvt_p_p_gov_group": 0,
  • "dvt_treasury_withdrawal": 0,
  • "committee_min_size": "string",
  • "committee_max_term_length": "string",
  • "gov_action_lifetime": "string",
  • "gov_action_deposit": "string",
  • "drep_deposit": "string",
  • "drep_activity": "string",
  • "pvtpp_security_group": 0,
  • "min_fee_ref_script_cost_per_byte": 0
}

Cardano » Governance

Delegate Representatives (DReps)

Return the information about Delegate Representatives (DReps)

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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. Ordering in this case is based on the time of the first mint transaction.

Responses

Response samples

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

Specific DRep

DRep information.

Authorizations:
project_id
path Parameters
drep_id
required
string
Example: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc

Bech32 or hexadecimal DRep ID.

Responses

Response samples

Content type
application/json
{
  • "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc",
  • "hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d",
  • "amount": "2000000",
  • "active": true,
  • "active_epoch": 420,
  • "has_script": true
}

DRep delegators

List of Drep delegators.

Authorizations:
project_id
path Parameters
drep_id
required
string
Example: drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn

Bech32 or hexadecimal drep ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    },
  • {
    },
  • {
    }
]

DRep metadata

DRep metadata information.

Authorizations:
project_id
path Parameters
drep_id
required
string
Example: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc

Bech32 or hexadecimal DRep ID.

Responses

Response samples

Content type
application/json
{}

DRep updates

List of certificate updates to the DRep.

Authorizations:
project_id
path Parameters
drep_id
required
string
Example: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc

Bech32 or hexadecimal DRep ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    },
  • {
    }
]

DRep votes

History of Drep votes.

Authorizations:
project_id
path Parameters
drep_id
required
string
Example: drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn

Bech32 or hexadecimal drep ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    },
  • {
    }
]

Proposals

Return the information about Proposals

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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. Ordering in this case is based on the time of the first mint transaction.

Responses

Response samples

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

Specific proposal

Proposal information.

Authorizations:
project_id
path Parameters
tx_hash
required
string
Example: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531

Transaction hash.

cert_index
required
integer
Example: 1

Transaction index.

Responses

Response samples

Content type
application/json
{
  • "tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531",
  • "cert_index": 1,
  • "governance_type": "treasury_withdrawals",
  • "deposit": 12000,
  • "return_address": "stake_test1urd3hs7rlxwwdzthe6hj026dmyt3y0heuulctscyydh2kgck6nkmz",
  • "governance_description": "TreasuryWithdrawals (fromList [(RewardAcnt {getRwdNetwork = Testnet, getRwdCred = KeyHashObj (KeyHash \"71317e951b20aa46e9fbf45a46a6e950d5723a481225519655bf6c60\")},Coin 20000000)])",
  • "ratified_epoch": null,
  • "enacted_epoch": 123,
  • "dropped_epoch": null,
  • "expired_epoch": null,
  • "expiration": 120
}

Specific parameters proposal

Parameters proposal details.

Authorizations:
project_id
path Parameters
tx_hash
required
string
Example: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531

Transaction hash.

cert_index
required
integer
Example: 1

Transaction index.

Responses

Response samples

Content type
application/json
{
  • "tx_hash": "string",
  • "cert_index": 0,
  • "parameters": {
    }
}

Specific withdrawals proposal

Parameters withdrawals details.

Authorizations:
project_id
path Parameters
tx_hash
required
string
Example: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531

Transaction hash.

cert_index
required
integer
Example: 1

Transaction index.

Responses

Response samples

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

Proposal votes

History of Proposal votes.

Authorizations:
project_id
path Parameters
tx_hash
required
string
Example: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531

Transaction hash.

cert_index
required
integer
Example: 1

Transaction index.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 proposal metadata

Proposal metadata information.

Authorizations:
project_id
path Parameters
tx_hash
required
string
Example: 2403339d2f344202fb3583353e11a693a82860e59e65939dcb0e2ac72336d631

Transaction hash of the proposal.

cert_index
required
integer

Transaction index of the proposal.

Responses

Response samples

Content type
application/json
{
  • "tx_hash": "257d75c8ddb0434e9b63e29ebb6241add2b835a307aa33aedba2effe09ed4ec8",
  • "cert_index": 2,
  • "url": "https://raw.githubusercontent.com/carloslodelar/proposals/main/pv10.json",
  • "hash": "ffa226f3863aca006172d559cf46bb8b883a47233962ae2fc94c158d7de6fa81",
  • "json_metadata": {
    },
  • "bytes": "\\x7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d"
}

Cardano » Ledger

Blockchain genesis

Return the information about blockchain genesis.

Authorizations:
project_id

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 » Mempool

Mempool

Return transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block. Shows only transactions submitted via Blockfrost.io.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
Default: 1

The page number for listing the results.

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

Ordered by the time of transaction submission. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Specific transaction in the mempool

Return content of the requested transaction.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
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
{
  • "tx": {
    },
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "redeemers": [
    ]
}

Mempool by address

List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. Shows only transactions submitted via Blockfrost.io.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
path Parameters
address
required
string <64-character case-sensitive hexadecimal string.>
Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz

Bech32 address.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
Default: 1

The page number for listing the results.

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

Ordered by the time of transaction submission. By default, we return oldest first, newest last.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cardano » Metadata

Transaction metadata labels

List of all used transaction metadata labels.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
label
required
string
Example: 1990

Metadata label

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
label
required
string
Example: 1990

Metadata label

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 » Mithril

Mithril integration allows you to leverage the capabilities of the Mithril Aggregator API without needing to interact with multiple APIs, simplifying the development process and enhancing usability.

Please note that the integration of Mithril is experimental. Blockfrost acts as a proxy for the subset of Mithril API endpoints. The format of the Mithril API may change independently of the core Blockfrost API.

All Mithril endpoints are accessible under the /mithril path.

For example, to retrieve a snapshot artifact of the cardano mainnet, you would use: https://cardano-mainnet.blockfrost.io/api/v0/mithril/artifact/snapshot/{digest}

In addition to error responses listed in Mithril endpoints (such as 404, 412 and 500), the API may also return error responses related to Blockfrost (e.g. 400 for invalid path or 403 for unauthenticated request). For the full list of Blockfrost error status codes, please see Blockfrost Errors.

For more information about how to use Mithril API, please see the Mithril docs.

Get public specifications about the aggregator

Returns the specifications related to the aggregator:

  • Open API version
  • URL of Mithril documentation
  • Capabilities of the aggregator
  • Cardano transactions prover capabilities
Authorizations:
project_id

Responses

Response samples

Content type
application/json
{
  • "open_api_version": "0.1.17",
  • "documentation_url": "https://mithril.network",
  • "capabilities": {
    }
}

Get current epoch settings

Returns the information related to the current epoch:

  • protocol parameters for current epoch
  • protocol parameters for next epoch (to setup cryptography, allowing signers to register)
Authorizations:
project_id

Responses

Response samples

Content type
application/json
{
  • "epoch": 329,
  • "protocol": {
    },
  • "next_protocol": {
    }
}

Get current pending certificate information

Returns the information related to the current pending certificate:

  • protocol parameters, for current and next epoch (to setup cryptography)
  • beacon information (where on the chain the pending certificate should be triggered)
  • entity type of the message that must be signed
  • verification keys of the signers, for current and next epoch
Authorizations:
project_id

Responses

Response samples

Content type
application/json
{
  • "epoch": 329,
  • "beacon": {
    },
  • "entity_type": {
    },
  • "protocol": {
    },
  • "next_protocol": {
    },
  • "signers": [
    ],
  • "next_signers": [
    ]
}

Get most recent certificates

Returns the list of the most recent certificates

Authorizations:
project_id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get certificate by hash

Returns the certificate identified by its hash

Authorizations:
project_id
path Parameters
certificate_hash
required
string <bytes>
Example: 7905e83ab5d7bc082c1bbc3033bfd19c539078830d19080d1f241c70aa532572

Hash of the certificate to retrieve

Responses

Response samples

Content type
application/json
{
  • "hash": "9dc998101590f733f7a50e7c03b5b336e69a751cc02d811395d49618db3ba3d7",
  • "previous_hash": "aa2ddfb87a17103bdf15bfb21a2941b3f3223a3c8d710910496c392b14f8c403",
  • "epoch": 329,
  • "beacon": {
    },
  • "signed_entity_type": {
    },
  • "metadata": {
    },
  • "protocol_message": {
    },
  • "signed_message": "07ed7c9e128744c1a4797b7eb34c54823cc7a21fc95c19876122ab4bb0fe796d6bba2bc",
  • "aggregate_verification_key": "7b232392c3130342c34392c35312c3130332c3136352c37364223a7b22726f6f74223a5b3137392c3135312c3135382c37332c37372c2c3135392c3226d745f636f6d6d69746d656e7",
  • "multi_signature": "7bc3139392c3135392c3235342c3231392c3133362c3132392c38342c353227369676e617475726573223a5b5b7b227369676d61223a5b3135312c362c3131222c33382c3135382c3137312c3137312c3234392c32342c3232382c3133302c38352c32362c38382c3135382c32303c323337322c323339362c32342c313530342c313532302c3135323737302c323830372c323831392c323834302c323834342c323836302c323837322c323838362c323839312c323839382c3239333533332c343538352c343632342c343634322c343634372c343636362c334312c31343636382c31343637352c31343639352c31343639392c31343730312c31343730352c31343733302c31343733382c31343733392c31343734362c31343735342c31343736312c31343738362c31343739352c31343739362c31343832362c31343835392c31343836302c31343836322c31343837312c31343837322c31343837392c31343838392c31343839332c31343839372c31343839392c31343932362c31343937372c31343939312c31353032332c31353033382c31353034342c31353036332c31353039312c31353039322c31353039382c31353131392c31353132312c31353136362c31353139362c31353230322c31353231302c31353231392c31353233392c31353234362c31353235322c31353237352c31353238312c31353334372c31353335372c31353338372c31353431372c31353434352c31353434382c31353435332c31353435342c31353530382c31353534352c31353536302c31353537302c31353538392c31353631302c31353631312c31353631322c31353632382c31353633302c31353633392c31353636302c31353636312c31353637392c31353731372c31353731392c31353732362c31353733382c31353734382c31353735392c31353736312c31353739312c31353830312c31353830332c31353831342c31353831392c31353832372c31353832392c31353834392c31353835332c31353835372c31353835392c31353836372c31353839362c31353930312c31353930372c31353931302c31353931332c31353931352c31353935352c31353937362c31353938372c31363031372c31363036332c31363131382c31363132382c31363135352c31363136372c31363230312c31363230362c31363231392c31363232312c31363232392c31363233342c31363234362c31363333302c31363335302c31363336362c31353739312c31353830312c31353830332c31353831342c31353831392c31353832372c31353832392c31353834392c31353835332c31353835372c31353835392c31353836372c31353839362c31353930312c31353930372c31353931302c31353931332c31353931352c31353935352c31353937362c31353938372c31363031372c31363036332c31363131382c31363132382c31363135352c31363136372c31363230312c31363230362c31363231392c31363232312c31363232392c31363233342c31363234362c31363333302c31363335302c31363336362c31363339302c31363430342c31363435342c31363437392c31363533302c31363533382c31363534372c31363535322c31363630382c31363631312c31363631382c31363633312c31363635382c31363637312c31363639352c31363730302c31363731332c31363732372c31363733312c31363733322c31363734322c31363736302c31363737342c31363739322c31363739362c31363739382c31363830342c31363831302c31363834302c31363834382c31363835392c31363836332c31363838362c31363838382c31363930302c31363932372c31363932382c31363932392c31363933372c31363934302c31363934362c31363935302c31363936312c31363938312c31373033302c31373035332c31373036322c31373038322c31373130312c31373130332c31373130352c31373130362c31373132302c31373132312c31373133322c31373133332c31373135312c31373135392c31373138332c31373232302c31373239322c31373331312c31373331332c31373332362c31373333362c31373334352c31373334392c31373335372c31373337352c31373338332c31373338352c31373430302c31373430362c31373431342c31373432322c31373434362c31373435312c31373436362c31373530322c31373531392c31373535382c31373536352c31373537332c31373538302c31373630362c31373632332c31373636382c31373639352c31373732392c31373733312c31373733352c31373733372c31373734342c31373734352c31373734372c31373736382c31373737302c31373737332c31373737352c31373739362c31373830342c31373831302c31373831332c31373832332c31373834352c31373834362c31373838382c31373839342c31373930352c31373931302c31373935372c31373936372c31373938372c31373939342c31383030322c31383030332c31383031312c31383032302c31383032392c31383034362c31383036382c31383037322c31383131372c31383133372c31383134302c31383134332c31383136322c31383137302c31383137342c31383138342c31383138392c31383139392c31383230382c31383232302c31383235312c31383235332c31383237392c31383238312c31383239312c31383239382c31383330312c31383331362c31383332382c31383334312c31383336332c31383337342c31383338352c31383338372c31383434392c31383437362c31383438322c31383439382c31383530352c31383530362c31383531342c31383532362c31383532382c31383533382c31383535322c31383535382c31383537342c31383538342c31383539322c31383631392c32c3832392c3834382c3835312c3835342c3836352c3838332c3838342c3839332c3839372c3930392c3937312c3938362c3939352c313032312c313032362c313035312c313036322c313036382c313038322c313038332c313038352c313133312c313134392c313135392c313136342c313137322c313137332c313231372c313231382c313234372c313239332c313330382c313331352c313333302c313335302c313336342c313337392c313430302c313430362c313432372c313434392c313436342c313436362c313436372c313437362c313530312c313530342c313532302c313532352c313533322c313534322c313536372c313537362c313538322c313538332c313632362c313633322c313633332c313634312c313635322c313730302c313732392c313831322c313832302c313834322c313835392c313837312c313930352c313930372c313931322c313931332c313935362c313936302c313937342c323030302c323031302c323033322c323033372c323037372c323038372c323039382c323130372c323131382c323133322c323133382c323135312c323230332c323230392c323231312c323233372c323234382c323235332c323237372c323238302c323330382c323331342c323333322c323334332c323334382c373535362c373535382c373537372c373630392c373631382c373633392c373635342c373635352c373731392c373732322c373732332c373830342c373832372c373833362c373833372c373835302c373835332c373835362c373837382c373839362c373931392c373933312c373933332c373934332c373934362c373935342c383030302c383031302c383031342c383033302c383034332c383035352c383036342c383036382c383037362c383132322c383134332c383134382c383136362c383139302c383234372c383235312c383236302c383237352c383238312c383238352c383330362c383332352c383337332c383337372c383338372c383339372c383339382c383431362c383433312c383436362c383436372c383437372c383438332c383438392c383439322c383439382c383531372c383533302c383533352c383534302c383536392c383539392c383631322c383634322c383635322c383637302c383730312c383733342c383738382c383739312c383832372c383834352c383835312c383836312c383837362c383932392c383933372c383935322c383937362c393031362c393032302c393032372c393032392c393034382c393036302c393038392c393130332c393130362c393131312c393131322c393131382c393133342c393134392c393137372c393137382c393231312c393231322c393232392c393234332c393236312c393236322c393238362c393239372c393331382c393333392c393338312c393339352c393339362c393431372c393433302c393436332c393439322c393532342c393633332c393633352c393634322c393639322c393731382c393732342c393732362c393733352c393735362c393738302c393738322c393739332c393831332c393837312c393839382c393931382c393932332c393932362c393934312c393934392c393935322c393935382c393936312c393936342c393937352c31303030362c31303032362c31303032392c31303035382c31303037342c31303037392c31303131302c31303132332c31303133392c31303134382c31303135362c31303136392c31303230362c31303235352c31303235372c31303235382c31303237332c31303237342c31303239312c31303239332c31303239342c31303330352c31303334312c31303334332c31303338322c31303338332c31303430342c31303431312c31303431332c31303432302c31303434322c31303434342c31303435372c31303436302c31303437322c31303438372c31303532322c31303535312c31303536342c31303636352c31303638352c31303730302c31303730362c31303733322c31303734332c31303737322c31303831352c31303833332c31303834332c31303836362c31303839322c31303930382c31303938382c31313033362c31313034312c31313037312c31313038322c31313039322c31313039392c31313130392c31313131352c31313134362c31313139332c31313230302c31313232382c31313232392c31313235342c31313236372c31313238302c31313239332c31313239352c31313331312c31313331382c31313332322c31313334302c31313334342c31313335322c31313335342c31313335352c31313335362c31313338352c31313430322c31313431332c31313433342c31313434322c31313436382c31313437322c31313437372c31313439362c31313439392c31313530362c31313531302c31313532342c31313532372c31313534342c31313538312c31313539322c31313630342c31313633352c31313635382c31313733332c31313733362c31313735342c31313739342c31313831332c31313831392c31313832342c31313832372c31313836392c31313837312c31313931342c31313937302c31313937342c31323031362c31323031392c31323034302c31323034342c31323035342c31323036382c31323037302c31323037372c31323039392c31323130342c31323133302c31323133392c31323135302c31323135392c31323136302c31323137352c31323230302c31323230322c31323232382c31323233392c31323330352c31323336382c31323337352c31323337392c31323338392c31323430372c31323431302c31323433322c31323434302c31323434312c31323437352c31323530362c31323531322c31323531332c31323531372c31323532312c31323533302c31323538302c31323633362c31323636392c31323637322c31323637362c31323637372c31323638332c31323638372c31323730352c31323732342c31323734362c31323734382c31323737362c31323739392c31323838352c31323839392c31323930372c31323933302c31323933322c31323935382c31323939332c31333030332c31333033302c31333036312c31333038302c31333038332c31333130352c31333132372c31333133312c31333136392c31333138312c31333138322c31333138352c3133323231231333236352c31333238362c31333234322cc31333239342c3131333438362c1e233332362c31333333392c31333336352c31333337332c31333338352c31333339392c31333433332c31333435312c31333437382c3",
  • "genesis_signature": ""
}

Get most recent snapshots

Returns the list of the most recent snapshots

Authorizations:
project_id

Responses

Response samples

Content type
application/json
[]

Get snapshot information

Returns the information of a snapshot and where to retrieve its binary content

Authorizations:
project_id
path Parameters
digest
required
string <bytes>
Example: 6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732

Digest of the snapshot to retrieve

Responses

Response samples

Content type
application/json
{}

Download the snapshot

Returns the snapshot archive binary content

Authorizations:
project_id
path Parameters
digest
required
string <bytes>
Example: 6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732

Digest of the snapshot to download

Responses

Response samples

Content type
application/json
{
  • "label": "Internal error",
  • "message": "An error occurred, the operation could not be completed"
}

Get most recent Mithril stake distributions

Returns the list of the most recent Mithril stake distributions

Authorizations:
project_id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Mithril stake distribution information

Returns the information of a Mithril stake distribution

Authorizations:
project_id
path Parameters
hash
required
string <bytes>
Example: 6da2b104ed68481ef829d72d72c2f6a20142916d17985e01774b14ed49f0fea1

Hash of the Mithril stake distribution to retrieve

Responses

Response samples

Content type
application/json
{
  • "epoch": 123,
  • "hash": "6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732",
  • "certificate_hash": "7905e83ab5d7bc082c1bbc3033bfd19c539078830d19080d1f241c70aa532572",
  • "signers": [
    ],
  • "created_at": "2022-06-14T10:52:31Z",
  • "protocol_parameters": {
    }
}

Get most recent Cardano transactions set snapshots

Returns the list of the most recent Cardano transactions set snapshots

Authorizations:
project_id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Cardano transactions set snapshot information

Returns the information of a Cardano transactions set snapshot

Authorizations:
project_id
path Parameters
hash
required
string <bytes>
Example: 6da2b104ed68481ef829d72d72c2f6a20142916d17985e01774b14ed49f0fea1

Hash of the Cardano transactions set snapshot to retrieve

Responses

Response samples

Content type
application/json
{
  • "hash": "6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732",
  • "certificate_hash": "7905e83ab5d7bc082c1bbc3033bfd19c539078830d19080d1f241c70aa532572",
  • "merkle_root": "33bfd17bc082ab5dd1fc0788241c70aa5325241c70aa532530d190809c5391bbc307905e8372",
  • "epoch": 123,
  • "block_number": 1234,
  • "created_at": "2022-06-14T10:52:31Z"
}

Get the proofs of a Cardano transaction list

Returns the transaction hashes and the corresponding proofs

Authorizations:
project_id
query Parameters
transaction_hashes
required
Array of strings <bytes> [ items <bytes > ]
Example: transaction_hashes=6dbb104ed68481ef829a26a20142916d17985e01774d72d72c2f

Hashes of the Cardano transactions to retrieve proofs for

Responses

Response samples

Content type
application/json
{
  • "certificate_hash": "7905e83ab5d7bc082c1bbc3033bfd19c539078830d19080d1f241c70aa532572",
  • "certified_transactions": [
    ],
  • "non_certified_transactions": [
    ],
  • "latest_block_number": 7060000
}

Get registered signers for an epoch

Returns the signers that registered at a given Epoch

Authorizations:
project_id
path Parameters
epoch
required
integer <int64>
Example: 419

Cardano Epoch at which the signer registrations are registered

Responses

Response samples

Content type
application/json
{
  • "registered_at": 420,
  • "signing_at": 422,
  • "registrations": [
    ]
}

Get the signers known by the aggregator

Returns the signers party id and, if available, their pool ticker

Authorizations:
project_id

Responses

Response samples

Content type
application/json
{
  • "network": "mainnet",
  • "signers": [
    ]
}

Cardano » Network

Network information

Return detailed network information.

Authorizations:
project_id

Responses

Response samples

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

Query summary of blockchain eras

Returns start and end of each era along with parameters that can vary between hard forks.

Authorizations:
project_id

Responses

Response samples

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

Cardano » Pools

List of stake pools

List of registered stake pools.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of pools per page.

page
integer [ 1 .. 21474836 ]
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 stake pools with additional information

List of registered stake pools with additional information.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of pools per page.

page
integer [ 1 .. 21474836 ]
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 retired stake pools

List of already retired pools.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of pools per page.

page
integer [ 1 .. 21474836 ]
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:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
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,
  • "blocks_epoch": 4,
  • "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:
project_id
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

Responses

Response samples

Content type
application/json
Example
{
  • "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:
project_id
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:
project_id
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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:
project_id
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 votes

History of stake pools votes.

Authorizations:
project_id
path Parameters
pool_id
required
string
Example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy

Bech32 or hexadecimal pool ID.

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 » Scripts

Scripts

List of scripts.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 script

Information about a specific script

Authorizations:
project_id
path Parameters
script_hash
required
string
Example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e

Hash of the script

Responses

Response samples

Content type
application/json
{
  • "script_hash": "13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1",
  • "type": "plutusV1",
  • "serialised_size": 3119
}

Script JSON

JSON representation of a timelock script

Authorizations:
project_id
path Parameters
script_hash
required
string
Example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e

Hash of the script

Responses

Response samples

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

Script CBOR

CBOR representation of a plutus script

Authorizations:
project_id
path Parameters
script_hash
required
string
Example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e

Hash of the script

Responses

Response samples

Content type
application/json
{
  • "cbor": "4e4d01000033222220051200120011"
}

Redeemers of a specific script

List of redeemers of a specific script

Authorizations:
project_id
path Parameters
script_hash
required
string
Example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e

Hash of the script

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    }
]

Datum value

Query JSON value of a datum by its hash

Authorizations:
project_id
path Parameters
datum_hash
required
string
Example: db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d

Hash of the datum

Responses

Response samples

Content type
application/json
{
  • "json_value": {
    }
}

Datum CBOR value

Query CBOR serialised datum by its hash

Authorizations:
project_id
path Parameters
datum_hash
required
string
Example: db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d

Hash of the datum

Responses

Response samples

Content type
application/json
{
  • "cbor": "19a6aa"
}

Cardano » Transactions

Specific transaction

Return content of the requested transaction.

Authorizations:
project_id
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,
  • "block_time": 1635505891,
  • "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,
  • "redeemer_count": 0,
  • "valid_contract": true
}

Transaction UTXOs

Return the inputs and UTXOs of the specific transaction.

Authorizations:
project_id
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:
project_id
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:
project_id
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:
project_id
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:
project_id
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:
project_id
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:
project_id
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:
project_id
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:
project_id
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 redeemers

Obtain the transaction redeemers.

Authorizations:
project_id
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 required signers

Obtain the extra transaction witnesses.

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

Hash of the transaction

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transaction CBOR

Obtain the CBOR serialized transaction

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

Hash of the transaction

Responses

Response samples

Content type
application/json
{
  • "cbor": "84a40081825820203e5b61e0949ffc8fe594727cf7ed73c7396cc2bd212af9a680c9423b5880eb00018282583900f0c60254ecb0addd4c7e40c28fd05b65014ab4c8ecece06c7dcee5a0724bf93336a8225e7ef152b41aea955173be91af19250edea1ddafab1a000f42408258390014beadb876d0a2a593fe2f1b539389e00731290910170e9a1be78e847d2ccdc7af469706878018739bcfde9ae23f009c4ae38aee0a4b4f3a1b0000000253fa0f93021a0002922d031a0303c827a100818258207d3ae39f9a1c916ac7c13f10c7d67c70b870c286a1af71485455c5022a3f391d5840e2f481acd1601a3f39fa976317bba685ddd774621a92611edaaa3df9f48a3b13d8b25ecb2f28b031c1602512418efed3033e463a0dcd22a856c808033cc9e00ff5f6"
}

Submit a transaction

Submit an already serialized transaction to the network.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
Request Body schema: application/cbor
required

The transaction to submit, serialized in CBOR.

string

The transaction to submit, serialized in CBOR.

Responses

Request samples

Content type
application/cbor
83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573

Response samples

Content type
application/json
"d1662b24fa9fe985fc2dce47455df399cb2e31e1e1819339e885801cc3578908"

Cardano » Utilities

Derive an address

Derive Shelley address from an xpub

Authorizations:
project_id
path Parameters
xpub
required
string
Example: d507c8f866691bd96e131334c355188b1a1d0b2fa0ab11545075aab332d77d9eb19657ad13ee581b56b0f8d744d66ca356b93d42fe176b3de007d53e9c4c4e7a

Hex xpub

role
required
integer

Account role

index
required
integer
Example: 2

Address index

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Submit a transaction for execution units evaluation

Submit an already serialized transaction to evaluate how much execution units it requires.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
header Parameters
Content-Type
required
string
Value: "application/cbor"
Request Body schema: application/cbor
required

The transaction to submit, serialized in CBOR.

string

The transaction to submit, serialized in CBOR.

Responses

Request samples

Content type
application/cbor
83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573

Response samples

Content type
application/json
{ }

Submit a transaction for execution units evaluation (additional UTXO set)

Submit a JSON payload with transaction CBOR and additional UTXO set to evaluate how much execution units it requires.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
header Parameters
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

JSON payload

cbor
required
string

Transaction CBOR (encoded using base64 or base16).

Array of objects or objects[ items = 2 items ]

Additional UTXO as an array of tuples [TxIn, TxOut]. See https://ogmios.dev/mini-protocols/local-tx-submission/#additional-utxo-set.

Responses

Request samples

Content type
application/json
{
  • "cbor": "string",
  • "additionalUtxoSet": [
    ]
}

Response samples

Content type
application/json
{ }

IPFS » Add

Add a file 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.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
Request Body schema: multipart/form-data
file
string <binary>

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 IPFS gateway (useful if you do not want to rely on a public gateway, such as ipfs.blockfrost.dev).

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
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

Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.

Authorizations:
project_id
path Parameters
IPFS_path
required
string

Path to the IPFS object

query Parameters
filecoin
boolean

If set to true, the object will be pinned to Filecoin as well. If not specified, the object will only be pinned to IPFS.

Responses

Response samples

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

List pinned objects

List objects pinned to local storage

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
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",
  • "filecoin": true
}

Remove a IPFS pin

Remove pinned objects from local storage

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
path Parameters
IPFS_path
required
string

The path to the IPFS object

Responses

Response samples

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

Get Proof of Data Segment Inclusion (PoDSI)

Retrieve the Proof of Data Segment Inclusion (PoDSI) for a specific IPFS object.

Hosted Endpoint only available for hosted variant.

Authorizations:
project_id
path Parameters
IPFS_path
required
string

The path to the IPFS object

Responses

Response samples

Content type
application/json
{
  • "dealInfo": [
    ]
}

Specific nut.link address

List metadata about specific address

Authorizations:
project_id
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 of tickers of an oracle

List of records of a specific oracle

Authorizations:
project_id
path Parameters
address
required
string

Address of a metadata oracle

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 ticker for an address

List of records of a specific ticker

Authorizations:
project_id
path Parameters
address
required
string

Address of a metadata oracle

ticker
required
string

Ticker for the pool record

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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 ticker

List of records of a specific ticker

Authorizations:
project_id
path Parameters
ticker
required
string

Ticker for the pool record

query Parameters
count
integer [ 1 .. 100 ]
Default: 100

The number of results displayed on one page.

page
integer [ 1 .. 21474836 ]
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
[
  • {
    }
]