View Source blockfrost (blockfrost_erlang v0.1.0)

Summary

Functions

Query all results, until we get less than maximum items per page.

Assets associated with the account addresses

Detailed information about account associated addresses

Specific address - extended

Assets

Assets of a specific policy

Addresses affected in a specific block

Addresses affected in a specific block

Latest block

Latest block transactions

Latest block transactions

Latest epoch

Latest epoch protocol parameters

Blockchain genesis

Backend health status

Current backend time

Relay to an IPFS gateway

List pinned objects

Get pinned object details

Transaction metadata labels

Transaction metadata labels

Transaction metadata content in JSON

Transaction metadata content in JSON

Transaction metadata content in CBOR

Blockfrost usage metrics

Blockfrost endpoint usage metrics

Network information

Query summary of blockchain eras

List metadata about specific address

List tickers for a specific metadata oracle

List tickers for a specific metadata oracle

List of records of a specific ticker

List of records of a specific ticker

List of records of a specific ticker

List of stake pools

List of stake pools

Specific stake pool

List of stake pools with additional information

List of stake pools with additional information

List of retired stake pools

List of retired stake pools

List of retiring stake pools

List of retiring stake pools

Scripts

Redeemers of a specific script

Specific transaction

Transaction delegation certificates

Transaction metadata

Transaction metadata in CBOR

Transaction MIRs

Transaction stake pool retirement certificates

Transaction stake pool registration and update certificates

Transaction redeemers

Transaction stake addresses certificates

Transaction UTXOs

Transaction withdrawal

Root endpoint

Add a file or directory to IPFS

Remove pinned object from local storage

Submit a transaction

Submit a transaction for execution units evaluation

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

Setup Blockfrost API client using BLOCKFROST_TOKEN_PATH environment variable
Setup Blockfrost API client from string containing Blockfrost project token, i.e. mainnet1A2B3C4D5E6F7G8H9I0J1K2L3M4N5O6P

Types

-type error() :: #error{}.
-type network() :: mainnet | preprod | preview | sanchonet | ipfs.
-type paged() :: #paged{}.
-type sort_order() :: #sort_order{}.

Functions

-spec all_pages(fun((paged()) -> any())) -> {ok, any()} | error.

Query all results, until we get less than maximum items per page.

Usage: blockfrost:all_pages(fun(P) -> blockfrost:get_latest_block_txs(P, #sort_order{}) end).
Link to this function

get_accounts_by_stake_address(Stake_address)

View Source
-spec get_accounts_by_stake_address(string()) -> {ok, jsx:json_term()} | error.

Specific account address

Obtain information about a specific stake account.

Endpoint /accounts/{stake_address}
Link to this function

get_accounts_by_stake_address_addresses(Stake_address)

View Source
-spec get_accounts_by_stake_address_addresses(string()) -> {ok, jsx:json_term()} | error.

Account associated addresses

Obtain information about the addresses of a specific account.

Endpoint /accounts/{stake_address}/addresses
Link to this function

get_accounts_by_stake_address_addresses(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_addresses(string(), paged(), sort_order()) ->
                                           {ok, jsx:json_term()} | error.

Account associated addresses

Obtain information about the addresses of a specific account.

Endpoint /accounts/{stake_address}/addresses

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_addresses_assets(Stake_address)

View Source
-spec get_accounts_by_stake_address_addresses_assets(string()) -> {ok, jsx:json_term()} | error.

Assets associated with the account addresses

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

Endpoint /accounts/{stake_address}/addresses/assets
Link to this function

get_accounts_by_stake_address_addresses_assets(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_addresses_assets(string(), paged(), sort_order()) ->
                                                  {ok, jsx:json_term()} | error.

Assets associated with the account addresses

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

Endpoint /accounts/{stake_address}/addresses/assets

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_addresses_total(Stake_address)

View Source
-spec get_accounts_by_stake_address_addresses_total(string()) -> {ok, jsx:json_term()} | error.

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.

Endpoint /accounts/{stake_address}/addresses/total
Link to this function

get_accounts_by_stake_address_delegations(Stake_address)

View Source
-spec get_accounts_by_stake_address_delegations(string()) -> {ok, jsx:json_term()} | error.

Account delegation history

Obtain information about the delegation of a specific account.

Endpoint /accounts/{stake_address}/delegations
Link to this function

get_accounts_by_stake_address_delegations(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_delegations(string(), paged(), sort_order()) ->
                                             {ok, jsx:json_term()} | error.

Account delegation history

Obtain information about the delegation of a specific account.

Endpoint /accounts/{stake_address}/delegations

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_history(Stake_address)

View Source
-spec get_accounts_by_stake_address_history(string()) -> {ok, jsx:json_term()} | error.

Account history

Obtain information about the history of a specific account.

Endpoint /accounts/{stake_address}/history
Link to this function

get_accounts_by_stake_address_history(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_history(string(), paged(), sort_order()) ->
                                         {ok, jsx:json_term()} | error.

Account history

Obtain information about the history of a specific account.

Endpoint /accounts/{stake_address}/history

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_mirs(Stake_address)

View Source
-spec get_accounts_by_stake_address_mirs(string()) -> {ok, jsx:json_term()} | error.

Account MIR history

Obtain information about the MIRs of a specific account.

Endpoint /accounts/{stake_address}/mirs
Link to this function

get_accounts_by_stake_address_mirs(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_mirs(string(), paged(), sort_order()) ->
                                      {ok, jsx:json_term()} | error.

Account MIR history

Obtain information about the MIRs of a specific account.

Endpoint /accounts/{stake_address}/mirs

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_registrations(Stake_address)

View Source
-spec get_accounts_by_stake_address_registrations(string()) -> {ok, jsx:json_term()} | error.

Account registration history

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

Endpoint /accounts/{stake_address}/registrations
Link to this function

get_accounts_by_stake_address_registrations(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_registrations(string(), paged(), sort_order()) ->
                                               {ok, jsx:json_term()} | error.

Account registration history

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

Endpoint /accounts/{stake_address}/registrations

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_rewards(Stake_address)

View Source
-spec get_accounts_by_stake_address_rewards(string()) -> {ok, jsx:json_term()} | error.

Specific reward history

Obtain information about the reward history of a specific account.

Endpoint /accounts/{stake_address}/rewards
Link to this function

get_accounts_by_stake_address_rewards(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_rewards(string(), paged(), sort_order()) ->
                                         {ok, jsx:json_term()} | error.

Specific reward history

Obtain information about the reward history of a specific account.

Endpoint /accounts/{stake_address}/rewards

Variant supporting paging and sorting
Link to this function

get_accounts_by_stake_address_withdrawals(Stake_address)

View Source
-spec get_accounts_by_stake_address_withdrawals(string()) -> {ok, jsx:json_term()} | error.

Account withdrawal history

Obtain information about the withdrawals of a specific account.

Endpoint /accounts/{stake_address}/withdrawals
Link to this function

get_accounts_by_stake_address_withdrawals(Stake_address, Paged, SortOrder)

View Source
-spec get_accounts_by_stake_address_withdrawals(string(), paged(), sort_order()) ->
                                             {ok, jsx:json_term()} | error.

Account withdrawal history

Obtain information about the withdrawals of a specific account.

Endpoint /accounts/{stake_address}/withdrawals

Variant supporting paging and sorting
Link to this function

get_addresses_by_address(Address)

View Source
-spec get_addresses_by_address(string()) -> {ok, jsx:json_term()} | error.

Specific address

Obtain information about a specific address.

Endpoint /addresses/{address}
Link to this function

get_addresses_by_address_extended(Address)

View Source
-spec get_addresses_by_address_extended(string()) -> {ok, jsx:json_term()} | error.

Specific address - extended

Obtain extended information about a specific address.

Endpoint /addresses/{address}/extended
Link to this function

get_addresses_by_address_total(Address)

View Source
-spec get_addresses_by_address_total(string()) -> {ok, jsx:json_term()} | error.

Address details

Obtain details about an address.

Endpoint /addresses/{address}/total
Link to this function

get_addresses_by_address_transactions(Address)

View Source
-spec get_addresses_by_address_transactions(string()) -> {ok, jsx:json_term()} | error.

Address transactions

Transactions on the address.

Endpoint /addresses/{address}/transactions
Link to this function

get_addresses_by_address_transactions(Address, Paged, SortOrder)

View Source
-spec get_addresses_by_address_transactions(string(), paged(), sort_order()) ->
                                         {ok, jsx:json_term()} | error.

Address transactions

Transactions on the address.

Endpoint /addresses/{address}/transactions

Variant supporting paging and sorting
Link to this function

get_addresses_by_address_utxos(Address)

View Source
-spec get_addresses_by_address_utxos(string()) -> {ok, jsx:json_term()} | error.

Address UTXOs

UTXOs of the address.

Endpoint /addresses/{address}/utxos
Link to this function

get_addresses_by_address_utxos(Address, Paged, SortOrder)

View Source
-spec get_addresses_by_address_utxos(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Address UTXOs

UTXOs of the address.

Endpoint /addresses/{address}/utxos

Variant supporting paging and sorting
Link to this function

get_addresses_by_address_utxos_by_asset(Address, Asset)

View Source
-spec get_addresses_by_address_utxos_by_asset(string(), string()) -> {ok, jsx:json_term()} | error.

Address UTXOs of a given asset

UTXOs of the address.

Endpoint /addresses/{address}/utxos/{asset}
Link to this function

get_addresses_by_address_utxos_by_asset(Address, Asset, Paged, SortOrder)

View Source
-spec get_addresses_by_address_utxos_by_asset(string(), string(), paged(), sort_order()) ->
                                           {ok, jsx:json_term()} | error.

Address UTXOs of a given asset

UTXOs of the address.

Endpoint /addresses/{address}/utxos/{asset}

Variant supporting paging and sorting
-spec get_assets() -> {ok, jsx:json_term()} | error.

Assets

List of assets.

Endpoint /assets
Link to this function

get_assets(Paged, SortOrder)

View Source
-spec get_assets(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Assets

List of assets.

Endpoint /assets

Variant supporting paging and sorting
Link to this function

get_assets_by_asset(Asset)

View Source
-spec get_assets_by_asset(string()) -> {ok, jsx:json_term()} | error.

Specific asset

Information about a specific asset.

Endpoint /assets/{asset}
Link to this function

get_assets_by_asset_addresses(Asset)

View Source
-spec get_assets_by_asset_addresses(string()) -> {ok, jsx:json_term()} | error.

Asset addresses

List of a addresses containing a specific asset

Endpoint /assets/{asset}/addresses
Link to this function

get_assets_by_asset_addresses(Asset, Paged, SortOrder)

View Source
-spec get_assets_by_asset_addresses(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Asset addresses

List of a addresses containing a specific asset

Endpoint /assets/{asset}/addresses

Variant supporting paging and sorting
Link to this function

get_assets_by_asset_history(Asset)

View Source
-spec get_assets_by_asset_history(string()) -> {ok, jsx:json_term()} | error.

Asset history

History of a specific asset.

Endpoint /assets/{asset}/history
Link to this function

get_assets_by_asset_history(Asset, Paged, SortOrder)

View Source
-spec get_assets_by_asset_history(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Asset history

History of a specific asset.

Endpoint /assets/{asset}/history

Variant supporting paging and sorting
Link to this function

get_assets_by_asset_transactions(Asset)

View Source
-spec get_assets_by_asset_transactions(string()) -> {ok, jsx:json_term()} | error.

Asset transactions

List of a specific asset transactions

Endpoint /assets/{asset}/transactions
Link to this function

get_assets_by_asset_transactions(Asset, Paged, SortOrder)

View Source
-spec get_assets_by_asset_transactions(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Asset transactions

List of a specific asset transactions

Endpoint /assets/{asset}/transactions

Variant supporting paging and sorting
Link to this function

get_assets_policy_by_policy_id(Policy_id)

View Source
-spec get_assets_policy_by_policy_id(string()) -> {ok, jsx:json_term()} | error.

Assets of a specific policy

List of asset minted under a specific policy.

Endpoint /assets/policy/{policy_id}
Link to this function

get_assets_policy_by_policy_id(Policy_id, Paged, SortOrder)

View Source
-spec get_assets_policy_by_policy_id(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Assets of a specific policy

List of asset minted under a specific policy.

Endpoint /assets/policy/{policy_id}

Variant supporting paging and sorting
Link to this function

get_blocks_by_hash_or_number(Hash_or_number)

View Source
-spec get_blocks_by_hash_or_number(integer() | string()) -> {ok, jsx:json_term()} | error.

Latest block transactions

Return the transactions within the latest block.

Endpoint /blocks/{hash_or_number}
Link to this function

get_blocks_by_hash_or_number_addresses(Hash_or_number)

View Source
-spec get_blocks_by_hash_or_number_addresses(integer() | string()) -> {ok, jsx:json_term()} | error.

Addresses affected in a specific block

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

Endpoint /blocks/{hash_or_number}/addresses
Link to this function

get_blocks_by_hash_or_number_addresses(Hash_or_number, Paged)

View Source
-spec get_blocks_by_hash_or_number_addresses(integer() | string(), paged()) ->
                                          {ok, jsx:json_term()} | error.

Addresses affected in a specific block

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

Endpoint /blocks/{hash_or_number}/addresses

Variant supporting paging
Link to this function

get_blocks_by_hash_or_number_next(Hash_or_number)

View Source
-spec get_blocks_by_hash_or_number_next(integer() | string()) -> {ok, jsx:json_term()} | error.

Listing of next blocks

Return the list of blocks following a specific block.

Endpoint /blocks/{hash_or_number}/next
Link to this function

get_blocks_by_hash_or_number_next(Hash_or_number, Paged)

View Source
-spec get_blocks_by_hash_or_number_next(integer() | string(), paged()) -> {ok, jsx:json_term()} | error.

Listing of next blocks

Return the list of blocks following a specific block.

Endpoint /blocks/{hash_or_number}/next

Variant supporting paging
Link to this function

get_blocks_by_hash_or_number_previous(Hash_or_number)

View Source
-spec get_blocks_by_hash_or_number_previous(integer() | string()) -> {ok, jsx:json_term()} | error.

Listing of preious blocks

Return the list of blocks preceeding a specific block.

Endpoint /blocks/{hash_or_number}/previous
Link to this function

get_blocks_by_hash_or_number_previous(Hash_or_number, Paged)

View Source
-spec get_blocks_by_hash_or_number_previous(integer() | string(), paged()) ->
                                         {ok, jsx:json_term()} | error.

Listing of preious blocks

Return the list of blocks preceeding a specific block.

Endpoint /blocks/{hash_or_number}/previous

Variant supporting paging
Link to this function

get_blocks_by_hash_or_number_txs(Hash_or_number)

View Source
-spec get_blocks_by_hash_or_number_txs(integer() | string()) -> {ok, jsx:json_term()} | error.

Block transactions

Return the transactions within the block.

Endpoint /blocks/{hash_or_number}/txs
Link to this function

get_blocks_by_hash_or_number_txs(Hash_or_number, Paged, SortOrder)

View Source
-spec get_blocks_by_hash_or_number_txs(integer() | string(), paged(), sort_order()) ->
                                    {ok, jsx:json_term()} | error.

Block transactions

Return the transactions within the block.

Endpoint /blocks/{hash_or_number}/txs

Variant supporting paging and sorting
Link to this function

get_blocks_epoch_by_epoch_number_slot_by_slot_number(Epoch_number, Slot_number)

View Source
-spec get_blocks_epoch_by_epoch_number_slot_by_slot_number(integer(), integer()) ->
                                                        {ok, jsx:json_term()} | error.

Specific block in a slot in an epoch

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

Endpoint /blocks/epoch/{epoch_number}/slot/{slot_number}
-spec get_blocks_latest() -> {ok, jsx:json_term()} | error.

Latest block

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

Endpoint /blocks/latest
-spec get_blocks_latest_txs() -> {ok, jsx:json_term()} | error.

Latest block transactions

Return the transactions within the latest block.

Endpoint /blocks/latest/txs
Link to this function

get_blocks_latest_txs(Paged, SortOrder)

View Source
-spec get_blocks_latest_txs(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Latest block transactions

Return the transactions within the latest block.

Endpoint /blocks/latest/txs

Variant supporting paging and sorting
Link to this function

get_blocks_slot_by_slot_number(Slot_number)

View Source
-spec get_blocks_slot_by_slot_number(integer()) -> {ok, jsx:json_term()} | error.

Specific block in a slot

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

Endpoint /blocks/slot/{slot_number}
Link to this function

get_epochs_by_epoch_number(Epoch_number)

View Source
-spec get_epochs_by_epoch_number(integer()) -> {ok, jsx:json_term()} | error.

Specific epoch

Return the content of the requested epoch.

Endpoint /epochs/{epoch_number}
Link to this function

get_epochs_by_epoch_number_blocks(Epoch_number)

View Source
-spec get_epochs_by_epoch_number_blocks(integer()) -> {ok, jsx:json_term()} | error.

Block distribution

Return the blocks minted for the epoch specified.

Endpoint /epochs/{epoch_number}/blocks
Link to this function

get_epochs_by_epoch_number_blocks(Epoch_number, Paged, SortOrder)

View Source
-spec get_epochs_by_epoch_number_blocks(integer(), paged(), sort_order()) ->
                                     {ok, jsx:json_term()} | error.

Block distribution

Return the blocks minted for the epoch specified.

Endpoint /epochs/{epoch_number}/blocks

Variant supporting paging and sorting
Link to this function

get_epochs_by_epoch_number_blocks_by_pool_id(Epoch_number, Pool_id)

View Source
-spec get_epochs_by_epoch_number_blocks_by_pool_id(integer(), string()) -> {ok, jsx:json_term()} | error.

Block distribution by pool

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

Endpoint /epochs/{epoch_number}/blocks/{pool_id}
Link to this function

get_epochs_by_epoch_number_blocks_by_pool_id(Epoch_number, Pool_id, Paged, SortOrder)

View Source
-spec get_epochs_by_epoch_number_blocks_by_pool_id(integer(), string(), paged(), sort_order()) ->
                                                {ok, jsx:json_term()} | error.

Block distribution by pool

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

Endpoint /epochs/{epoch_number}/blocks/{pool_id}

Variant supporting paging and sorting
Link to this function

get_epochs_by_epoch_number_next(Epoch_number)

View Source
-spec get_epochs_by_epoch_number_next(integer()) -> {ok, jsx:json_term()} | error.

List of next epochs

Return the list of epochs following a specific epoch.

Endpoint /epochs/{epoch_number}/next
Link to this function

get_epochs_by_epoch_number_next(Epoch_number, Paged)

View Source
-spec get_epochs_by_epoch_number_next(integer(), paged()) -> {ok, jsx:json_term()} | error.

List of next epochs

Return the list of epochs following a specific epoch.

Endpoint /epochs/{epoch_number}/next

Variant supporting paging
Link to this function

get_epochs_by_epoch_number_parameters(Epoch_number)

View Source
-spec get_epochs_by_epoch_number_parameters(integer()) -> {ok, jsx:json_term()} | error.

Protocol parameters

Return the protocol parameters for the specified epoch.

Endpoint /epochs/{epoch_number}/parameters
Link to this function

get_epochs_by_epoch_number_previous(Epoch_number)

View Source
-spec get_epochs_by_epoch_number_previous(integer()) -> {ok, jsx:json_term()} | error.

List of previous epochs

Return the list of epochs preceding a specific epoch.

Endpoint /epochs/{epoch_number}/previous
Link to this function

get_epochs_by_epoch_number_previous(Epoch_number, Paged)

View Source
-spec get_epochs_by_epoch_number_previous(integer(), paged()) -> {ok, jsx:json_term()} | error.

List of previous epochs

Return the list of epochs preceding a specific epoch.

Endpoint /epochs/{epoch_number}/previous

Variant supporting paging
Link to this function

get_epochs_by_epoch_number_stakes(Epoch_number)

View Source
-spec get_epochs_by_epoch_number_stakes(integer()) -> {ok, jsx:json_term()} | error.

Stake distribution

Return the active stake distribution for the specified epoch.

Endpoint /epochs/{epoch_number}/stakes
Link to this function

get_epochs_by_epoch_number_stakes(Epoch_number, Paged)

View Source
-spec get_epochs_by_epoch_number_stakes(integer(), paged()) -> {ok, jsx:json_term()} | error.

Stake distribution

Return the active stake distribution for the specified epoch.

Endpoint /epochs/{epoch_number}/stakes

Variant supporting paging
Link to this function

get_epochs_by_epoch_number_stakes_by_pool_id(Epoch_number, Pool_id)

View Source
-spec get_epochs_by_epoch_number_stakes_by_pool_id(integer(), string()) -> {ok, jsx:json_term()} | error.

Stake distribution by pool

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

Endpoint /epochs/{epoch_number}/stakes/{pool_id}
Link to this function

get_epochs_by_epoch_number_stakes_by_pool_id(Epoch_number, Pool_id, Paged)

View Source
-spec get_epochs_by_epoch_number_stakes_by_pool_id(integer(), string(), paged()) ->
                                                {ok, jsx:json_term()} | error.

Stake distribution by pool

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

Endpoint /epochs/{epoch_number}/stakes/{pool_id}

Variant supporting paging
-spec get_epochs_latest() -> {ok, jsx:json_term()} | error.

Latest epoch

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

Endpoint /epochs/latest
Link to this function

get_epochs_latest_parameters()

View Source
-spec get_epochs_latest_parameters() -> {ok, jsx:json_term()} | error.

Latest epoch protocol parameters

Return the protocol parameters for the latest epoch.

Endpoint /epochs/latest/parameters
-spec get_genesis() -> {ok, jsx:json_term()} | error.

Blockchain genesis

Return the information about blockchain genesis.

Endpoint /genesis
-spec get_health() -> {ok, jsx:json_term()} | error.

Backend health status

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

Endpoint /health
-spec get_health_clock() -> {ok, jsx:json_term()} | error.

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.

Endpoint /health/clock
Link to this function

get_ipfs_gateway_by_IPFS_path(Ipfs_path)

View Source
-spec get_ipfs_gateway_by_IPFS_path(string()) -> {ok, jsx:json_term()} | error.

Relay to an IPFS gateway

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

Endpoint /ipfs/gateway/{IPFS_path}
-spec get_ipfs_pin_list() -> {ok, jsx:json_term()} | error.

List pinned objects

List objects pinned to local storage.

Endpoint /ipfs/pin/list
Link to this function

get_ipfs_pin_list(Paged, SortOrder)

View Source
-spec get_ipfs_pin_list(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

List pinned objects

List objects pinned to local storage.

Endpoint /ipfs/pin/list

Variant supporting paging and sorting
Link to this function

get_ipfs_pin_list_by_IPFS_path(Ipfs_path)

View Source
-spec get_ipfs_pin_list_by_IPFS_path(string()) -> {ok, jsx:json_term()} | error.

Get pinned object details

Obtain inormation about specific pinned object.

Endpoint /ipfs/pin/list/{IPFS_path}
Link to this function

get_metadata_txs_labels()

View Source
-spec get_metadata_txs_labels() -> {ok, jsx:json_term()} | error.

Transaction metadata labels

List of all used transaction metadata labels.

Endpoint /metadata/txs/labels
Link to this function

get_metadata_txs_labels(Paged, SortOrder)

View Source
-spec get_metadata_txs_labels(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Transaction metadata labels

List of all used transaction metadata labels.

Endpoint /metadata/txs/labels

Variant supporting paging and sorting
Link to this function

get_metadata_txs_labels_by_label(Label)

View Source
-spec get_metadata_txs_labels_by_label(string()) -> {ok, jsx:json_term()} | error.

Transaction metadata content in JSON

Transaction metadata per label.

Endpoint /metadata/txs/labels/{label}
Link to this function

get_metadata_txs_labels_by_label(Label, Paged, SortOrder)

View Source
-spec get_metadata_txs_labels_by_label(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Transaction metadata content in JSON

Transaction metadata per label.

Endpoint /metadata/txs/labels/{label}

Variant supporting paging and sorting
Link to this function

get_metadata_txs_labels_by_label_cbor(Label)

View Source
-spec get_metadata_txs_labels_by_label_cbor(string()) -> {ok, jsx:json_term()} | error.

Transaction metadata content in CBOR

Transaction metadata per label.

Endpoint /metadata/txs/labels/{label}/cbor
Link to this function

get_metadata_txs_labels_by_label_cbor(Label, Paged, SortOrder)

View Source
-spec get_metadata_txs_labels_by_label_cbor(string(), paged(), sort_order()) ->
                                         {ok, jsx:json_term()} | error.

Transaction metadata content in CBOR

Transaction metadata per label.

Endpoint /metadata/txs/labels/{label}/cbor

Variant supporting paging and sorting
-spec get_metrics() -> {ok, jsx:json_term()} | error.

Blockfrost usage metrics

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

Endpoint /metrics
-spec get_metrics_endpoints() -> {ok, jsx:json_term()} | error.

Blockfrost endpoint usage metrics

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

Endpoint /metrics/endpoints
-spec get_network() -> {ok, jsx:json_term()} | error.

Network information

Return detailed network information.

Endpoint /network
-spec get_network_eras() -> {ok, jsx:json_term()} | error.

Query summary of blockchain eras

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

Endpoint /network/eras
-spec get_pools() -> {ok, jsx:json_term()} | error.

List of stake pools

List of registered stake pools.

Endpoint /pools
Link to this function

get_pools(Paged, SortOrder)

View Source
-spec get_pools(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

List of stake pools

List of registered stake pools.

Endpoint /pools

Variant supporting paging and sorting
Link to this function

get_pools_by_pool_id(Pool_id)

View Source
-spec get_pools_by_pool_id(string()) -> {ok, jsx:json_term()} | error.

Specific stake pool

Pool information.

Endpoint /pools/{pool_id}
Link to this function

get_pools_by_pool_id_blocks(Pool_id)

View Source
-spec get_pools_by_pool_id_blocks(string()) -> {ok, jsx:json_term()} | error.

Stake pool blocks

List of stake pool blocks.

Endpoint /pools/{pool_id}/blocks
Link to this function

get_pools_by_pool_id_blocks(Pool_id, Paged, SortOrder)

View Source
-spec get_pools_by_pool_id_blocks(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Stake pool blocks

List of stake pool blocks.

Endpoint /pools/{pool_id}/blocks

Variant supporting paging and sorting
Link to this function

get_pools_by_pool_id_delegators(Pool_id)

View Source
-spec get_pools_by_pool_id_delegators(string()) -> {ok, jsx:json_term()} | error.

Stake pool delegators

List of current stake pools delegators.

Endpoint /pools/{pool_id}/delegators
Link to this function

get_pools_by_pool_id_delegators(Pool_id, Paged, SortOrder)

View Source
-spec get_pools_by_pool_id_delegators(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Stake pool delegators

List of current stake pools delegators.

Endpoint /pools/{pool_id}/delegators

Variant supporting paging and sorting
Link to this function

get_pools_by_pool_id_history(Pool_id)

View Source
-spec get_pools_by_pool_id_history(string()) -> {ok, jsx:json_term()} | error.

Stake pool history

History of stake pool parameters over epochs.

Endpoint /pools/{pool_id}/history
Link to this function

get_pools_by_pool_id_history(Pool_id, Paged, SortOrder)

View Source
-spec get_pools_by_pool_id_history(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Stake pool history

History of stake pool parameters over epochs.

Endpoint /pools/{pool_id}/history

Variant supporting paging and sorting
Link to this function

get_pools_by_pool_id_metadata(Pool_id)

View Source
-spec get_pools_by_pool_id_metadata(string()) -> {ok, jsx:json_term()} | error.

Stake pool metadata

Stake pool registration metadata.

Endpoint /pools/{pool_id}/metadata
Link to this function

get_pools_by_pool_id_relays(Pool_id)

View Source
-spec get_pools_by_pool_id_relays(string()) -> {ok, jsx:json_term()} | error.

Stake pool relays

Relays of a stake pool.

Endpoint /pools/{pool_id}/relays
Link to this function

get_pools_by_pool_id_updates(Pool_id)

View Source
-spec get_pools_by_pool_id_updates(string()) -> {ok, jsx:json_term()} | error.

Stake pool updates

List of certificate updates to the stake pool.

Endpoint /pools/{pool_id}/updates
Link to this function

get_pools_by_pool_id_updates(Pool_id, Paged, SortOrder)

View Source
-spec get_pools_by_pool_id_updates(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Stake pool updates

List of certificate updates to the stake pool.

Endpoint /pools/{pool_id}/updates

Variant supporting paging and sorting
-spec get_pools_extended() -> {ok, jsx:json_term()} | error.

List of stake pools with additional information

List of registered stake pools with additional information.

Endpoint /pools/extended
Link to this function

get_pools_extended(Paged, SortOrder)

View Source
-spec get_pools_extended(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

List of stake pools with additional information

List of registered stake pools with additional information.

Endpoint /pools/extended

Variant supporting paging and sorting
-spec get_pools_retired() -> {ok, jsx:json_term()} | error.

List of retired stake pools

List of already retired stake pools.

Endpoint /pools/retired
Link to this function

get_pools_retired(Paged, SortOrder)

View Source
-spec get_pools_retired(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

List of retired stake pools

List of already retired stake pools.

Endpoint /pools/retired

Variant supporting paging and sorting
-spec get_pools_retiring() -> {ok, jsx:json_term()} | error.

List of retiring stake pools

List of stake pools retiring in the upcoming epochs

Endpoint /pools/retiring
Link to this function

get_pools_retiring(Paged, SortOrder)

View Source
-spec get_pools_retiring(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

List of retiring stake pools

List of stake pools retiring in the upcoming epochs

Endpoint /pools/retiring

Variant supporting paging and sorting
-spec get_scripts() -> {ok, jsx:json_term()} | error.

Scripts

List of scripts.

Endpoint /scripts
Link to this function

get_scripts(Paged, SortOrder)

View Source
-spec get_scripts(paged(), sort_order()) -> {ok, jsx:json_term()} | error.

Scripts

List of scripts.

Endpoint /scripts

Variant supporting paging and sorting
Link to this function

get_scripts_by_script_hash(Script_hash)

View Source
-spec get_scripts_by_script_hash(string()) -> {ok, jsx:json_term()} | error.

Specific scripts

Information about a specific script.

Endpoint /scripts/{script_hash}
Link to this function

get_scripts_by_script_hash_cbor(Script_hash)

View Source
-spec get_scripts_by_script_hash_cbor(string()) -> {ok, jsx:json_term()} | error.

Script CBOR

CBOR representation of a plutus script

Endpoint /scripts/{script_hash}/cbor
Link to this function

get_scripts_by_script_hash_json(Script_hash)

View Source
-spec get_scripts_by_script_hash_json(string()) -> {ok, jsx:json_term()} | error.

Script JSON

JSON representation of a timelock script

Endpoint /scripts/{script_hash}/json
Link to this function

get_scripts_by_script_hash_redeemers(Script_hash)

View Source
-spec get_scripts_by_script_hash_redeemers(string()) -> {ok, jsx:json_term()} | error.

Redeemers of a specific script

List of redeemers of a specific script.

Endpoint /scripts/{script_hash}/redeemers
Link to this function

get_scripts_by_script_hash_redeemers(Script_hash, Paged, SortOrder)

View Source
-spec get_scripts_by_script_hash_redeemers(string(), paged(), sort_order()) ->
                                        {ok, jsx:json_term()} | error.

Redeemers of a specific script

List of redeemers of a specific script.

Endpoint /scripts/{script_hash}/redeemers

Variant supporting paging and sorting
Link to this function

get_scripts_datum_by_datum_hash(Datum_hash)

View Source
-spec get_scripts_datum_by_datum_hash(string()) -> {ok, jsx:json_term()} | error.

Datum value

Query JSON value of a datum by its hash

Endpoint /scripts/datum/{datum_hash}
Link to this function

get_scripts_datum_by_datum_hash_cbor(Datum_hash)

View Source
-spec get_scripts_datum_by_datum_hash_cbor(string()) -> {ok, jsx:json_term()} | error.

Datum CBOR value

Query CBOR serialised datum by its hash

Endpoint /scripts/datum/{datum_hash}/cbor
-spec get_txs_by_hash(string()) -> {ok, jsx:json_term()} | error.

Specific transaction

Return content of the requested transaction.

Endpoint /txs/{hash}
Link to this function

get_txs_by_hash_delegations(Hash)

View Source
-spec get_txs_by_hash_delegations(string()) -> {ok, jsx:json_term()} | error.

Transaction delegation certificates

Obtain information about delegation certificates of a specific transaction.

Endpoint /txs/{hash}/delegations
Link to this function

get_txs_by_hash_metadata(Hash)

View Source
-spec get_txs_by_hash_metadata(string()) -> {ok, jsx:json_term()} | error.

Transaction metadata

Obtain the transaction metadata.

Endpoint /txs/{hash}/metadata
Link to this function

get_txs_by_hash_metadata_cbor(Hash)

View Source
-spec get_txs_by_hash_metadata_cbor(string()) -> {ok, jsx:json_term()} | error.

Transaction metadata in CBOR

Obtain the transaction metadata in CBOR.

Endpoint /txs/{hash}/metadata/cbor
Link to this function

get_txs_by_hash_mirs(Hash)

View Source
-spec get_txs_by_hash_mirs(string()) -> {ok, jsx:json_term()} | error.

Transaction MIRs

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

Endpoint /txs/{hash}/mirs
Link to this function

get_txs_by_hash_pool_retires(Hash)

View Source
-spec get_txs_by_hash_pool_retires(string()) -> {ok, jsx:json_term()} | error.

Transaction stake pool retirement certificates

Obtain information about stake pool retirements within a specific transaction.

Endpoint /txs/{hash}/pool_retires
Link to this function

get_txs_by_hash_pool_updates(Hash)

View Source
-spec get_txs_by_hash_pool_updates(string()) -> {ok, jsx:json_term()} | error.

Transaction stake pool registration and update certificates

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

Endpoint /txs/{hash}/pool_updates
Link to this function

get_txs_by_hash_redeemers(Hash)

View Source
-spec get_txs_by_hash_redeemers(string()) -> {ok, jsx:json_term()} | error.

Transaction redeemers

Obtain the transaction redeemers.

Endpoint /txs/{hash}/redeemers
Link to this function

get_txs_by_hash_stakes(Hash)

View Source
-spec get_txs_by_hash_stakes(string()) -> {ok, jsx:json_term()} | error.

Transaction stake addresses certificates

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

Endpoint /txs/{hash}/stakes
Link to this function

get_txs_by_hash_utxos(Hash)

View Source
-spec get_txs_by_hash_utxos(string()) -> {ok, jsx:json_term()} | error.

Transaction UTXOs

Return the inputs and UTXOs of the specific transaction.

Endpoint /txs/{hash}/utxos
Link to this function

get_txs_by_hash_withdrawals(Hash)

View Source
-spec get_txs_by_hash_withdrawals(string()) -> {ok, jsx:json_term()} | error.

Transaction withdrawal

Obtain information about withdrawals of a specific transaction.

Endpoint /txs/{hash}/withdrawals
Link to this function

get_utils_addresses_xpub_by_xpub_by_role_by_index(Xpub, Role, Index)

View Source
-spec get_utils_addresses_xpub_by_xpub_by_role_by_index(string(), integer(), integer()) ->
                                                     {ok, jsx:json_term()} | error.

Derive an address

Derive Shelley address from an xpub.

Endpoint /utils/addresses/xpub/{xpub}/{role}/{index}
-spec get_version() -> {ok, jsx:json_term()} | error.

Root endpoint

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

Endpoint /
-spec post_ipfs_add(term()) -> {ok, jsx:json_term()} | error.

Add a file or directory to IPFS

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

Endpoint /ipfs/add
Link to this function

post_ipfs_pin_add_by_IPFS_path(Ipfs_path)

View Source
-spec post_ipfs_pin_add_by_IPFS_path(string()) -> {ok, jsx:json_term()} | error.

Pin an object

Pinned objects are counted in your user storage quota.

Endpoint /ipfs/pin/add/{IPFS_path}
Link to this function

post_ipfs_pin_remove_by_IPFS_path(Ipfs_path)

View Source
-spec post_ipfs_pin_remove_by_IPFS_path(string()) -> {ok, jsx:json_term()} | error.

Remove pinned object from local storage

Remove pinned object from local storage

Endpoint /ipfs/pin/remove/{IPFS_path}
-spec post_tx_submit(term()) -> {ok, jsx:json_term()} | error.

Submit a transaction

Submit an already serialized transaction to the network.

Endpoint /tx/submit
Link to this function

post_utils_txs_evaluate(Body)

View Source
-spec post_utils_txs_evaluate(term()) -> {ok, jsx:json_term()} | error.

Submit a transaction for execution units evaluation

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

Endpoint /utils/txs/evaluate
Link to this function

post_utils_txs_evaluate_utxos(Body)

View Source
-spec post_utils_txs_evaluate_utxos(term()) -> {ok, jsx:json_term()} | error.

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.

Endpoint /utils/txs/evaluate/utxos
-spec setup() -> ok | {error, string()}.
Setup Blockfrost API client using BLOCKFROST_TOKEN_PATH environment variable
-spec setup(string()) -> ok | {error, string()}.
Setup Blockfrost API client from string containing Blockfrost project token, i.e. mainnet1A2B3C4D5E6F7G8H9I0J1K2L3M4N5O6P