View Source blockfrost (blockfrost_erlang v0.1.0)
Summary
Functions
Query all results, until we get less than maximum items per page.
Specific account address
Account associated addresses
Account associated addresses
Assets associated with the account addresses
Assets associated with the account addresses
Detailed information about account associated addresses
Account delegation history
Account delegation history
Account history
Account MIR history
Account MIR history
Account registration history
Account registration history
Specific reward history
Specific reward history
Account withdrawal history
Account withdrawal history
Specific address
Specific address - extended
Address details
Address transactions
Address transactions
Address UTXOs
Address UTXOs of a given asset
Address UTXOs of a given asset
Assets
Assets
Specific asset
Asset addresses
Asset addresses
Asset history
Asset history
Asset transactions
Asset transactions
Assets of a specific policy
Assets of a specific policy
Latest block transactions
Addresses affected in a specific block
Addresses affected in a specific block
Listing of next blocks
Listing of next blocks
Listing of preious blocks
Listing of preious blocks
Block transactions
Block transactions
Specific block in a slot in an epoch
Latest block
Latest block transactions
Latest block transactions
Specific block in a slot
Specific epoch
Block distribution
Block distribution
Block distribution by pool
Block distribution by pool
List of next epochs
List of next epochs
Protocol parameters
List of previous epochs
List of previous epochs
Stake distribution
Stake distribution
Stake distribution by pool
Stake distribution by pool
Latest epoch
Latest epoch protocol parameters
Blockchain genesis
Backend health status
Current backend time
Relay to an IPFS gateway
List pinned objects
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
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 records of a specific ticker
List of stake pools
List of stake pools
Specific stake pool
Stake pool blocks
Stake pool blocks
Stake pool delegators
Stake pool delegators
Stake pool history
Stake pool history
Stake pool metadata
Stake pool relays
Stake pool updates
Stake pool updates
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
Scripts
Specific scripts
Script CBOR
Script JSON
Redeemers of a specific script
Redeemers of a specific script
Datum value
Datum CBOR value
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
Derive an address
Root endpoint
Add a file or directory to IPFS
Pin an object
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)
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).-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}
-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
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
-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
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
-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
-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
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
-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
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
-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
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
-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
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
-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
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
-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
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
-spec get_addresses_by_address(string()) -> {ok, jsx:json_term()} | error.
Specific address
Obtain information about a specific address.
Endpoint/addresses/{address}
-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
-spec get_addresses_by_address_total(string()) -> {ok, jsx:json_term()} | error.
Address details
Obtain details about an address.
Endpoint/addresses/{address}/total
-spec get_addresses_by_address_transactions(string()) -> {ok, jsx:json_term()} | error.
Address transactions
Transactions on the address.
Endpoint/addresses/{address}/transactions
-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
-spec get_addresses_by_address_utxos(string()) -> {ok, jsx:json_term()} | error.
Address UTXOs
UTXOs of the address.
Endpoint/addresses/{address}/utxos
-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
-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}
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}
-spec get_assets() -> {ok, jsx:json_term()} | error.
Assets
List of assets.
Endpoint/assets
-spec get_assets(paged(), sort_order()) -> {ok, jsx:json_term()} | error.
Assets
List of assets.
Endpoint /assets
-spec get_assets_by_asset(string()) -> {ok, jsx:json_term()} | error.
Specific asset
Information about a specific asset.
Endpoint/assets/{asset}
-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
-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
-spec get_assets_by_asset_history(string()) -> {ok, jsx:json_term()} | error.
Asset history
History of a specific asset.
Endpoint/assets/{asset}/history
-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
-spec get_assets_by_asset_transactions(string()) -> {ok, jsx:json_term()} | error.
Asset transactions
List of a specific asset transactions
Endpoint/assets/{asset}/transactions
-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
-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}
-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}
-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}
-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
-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
-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
-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
-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
-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
-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
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
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
-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
-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}
-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}
-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
-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
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}
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}
-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
-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
-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
-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
-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
-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
-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
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}
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}
-spec get_epochs_latest() -> {ok, jsx:json_term()} | error.
Latest epoch
Return the information about the latest, therefore current, epoch.
Endpoint/epochs/latest
-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
-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
-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
-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}
-spec get_metadata_txs_labels() -> {ok, jsx:json_term()} | error.
Transaction metadata labels
List of all used transaction metadata labels.
Endpoint/metadata/txs/labels
-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
-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}
-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}
-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
-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
-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_nutlink_by_address(string()) -> {ok, jsx:json_term()} | error.
List metadata about specific address
List metadata about specific address
Endpoint/nutlink/{address}
-spec get_nutlink_by_address_tickers(string()) -> {ok, jsx:json_term()} | error.
List tickers for a specific metadata oracle
List tickers for a specific metadata oracle
Endpoint/nutlink/{address}/tickers
-spec get_nutlink_by_address_tickers(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.
List tickers for a specific metadata oracle
List tickers for a specific metadata oracle
Endpoint /nutlink/{address}/tickers
-spec get_nutlink_by_address_tickers_by_ticker(string(), string()) -> {ok, jsx:json_term()} | error.
List of records of a specific ticker
List of records of a specific ticker
Endpoint/nutlink/{address}/tickers/{ticker}
get_nutlink_by_address_tickers_by_ticker(Address, Ticker, Paged, SortOrder)
View Source-spec get_nutlink_by_address_tickers_by_ticker(string(), string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.
List of records of a specific ticker
List of records of a specific ticker
Endpoint /nutlink/{address}/tickers/{ticker}
-spec get_nutlink_tickers_by_ticker(string()) -> {ok, jsx:json_term()} | error.
List of records of a specific ticker
List of records of a specific ticker
Endpoint/nutlink/tickers/{ticker}
-spec get_nutlink_tickers_by_ticker(string(), paged(), sort_order()) -> {ok, jsx:json_term()} | error.
List of records of a specific ticker
List of records of a specific ticker
Endpoint /nutlink/tickers/{ticker}
-spec get_pools() -> {ok, jsx:json_term()} | error.
List of stake pools
List of registered stake pools.
Endpoint/pools
-spec get_pools(paged(), sort_order()) -> {ok, jsx:json_term()} | error.
List of stake pools
List of registered stake pools.
Endpoint /pools
-spec get_pools_by_pool_id(string()) -> {ok, jsx:json_term()} | error.
Specific stake pool
Pool information.
Endpoint/pools/{pool_id}
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-spec get_pools_retired() -> {ok, jsx:json_term()} | error.
List of retired stake pools
List of already retired stake pools.
Endpoint/pools/retired
-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
-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
-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
-spec get_scripts() -> {ok, jsx:json_term()} | error.
Scripts
List of scripts.
Endpoint/scripts
-spec get_scripts(paged(), sort_order()) -> {ok, jsx:json_term()} | error.
Scripts
List of scripts.
Endpoint /scripts
-spec get_scripts_by_script_hash(string()) -> {ok, jsx:json_term()} | error.
Specific scripts
Information about a specific script.
Endpoint/scripts/{script_hash}
-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
-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
-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
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
-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}
-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}
-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
-spec get_txs_by_hash_metadata(string()) -> {ok, jsx:json_term()} | error.
Transaction metadata
Obtain the transaction metadata.
Endpoint/txs/{hash}/metadata
-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
-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
-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
-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
-spec get_txs_by_hash_redeemers(string()) -> {ok, jsx:json_term()} | error.
Transaction redeemers
Obtain the transaction redeemers.
Endpoint/txs/{hash}/redeemers
-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
-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
-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
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
-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}
-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
-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
-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()}.
-spec setup(string()) -> ok | {error, string()}.
mainnet1A2B3C4D5E6F7G8H9I0J1K2L3M4N5O6P