Blockfrost.Client

Blockfrost client

Documentation

module Blockfrost.API

module Blockfrost.Env

module Blockfrost.Types

module Blockfrost.Lens

module Blockfrost.Client.Core

module Blockfrost.Client.Types

getRoot :: MonadBlockfrost m => m URLVersion

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

getHealth :: MonadBlockfrost m => m Healthy

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

getClock :: MonadBlockfrost m => m ServerTime

Get current backend time

getMetrics :: MonadBlockfrost m => m [Metric]

Get Blockfrost usage metrics over last 30 days

getMetricsEndpoints :: MonadBlockfrost m => m [(Text, Metric)]

Get Blockfrost endpoint usage metrics over last 30 days

getAccount :: MonadBlockfrost m => Address -> m AccountInfo

Obtain information about a specific stake account.

getAccountRewards :: MonadBlockfrost m => Address -> m [AccountReward]

Obtain information about the history of a specific account.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountRewards' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AccountReward]

Obtain information about the history of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountHistory :: MonadBlockfrost m => Address -> m [AccountHistory]

Obtain information about the history of a specific account.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountHistory' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AccountHistory]

Obtain information about the history of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountDelegations :: MonadBlockfrost m => Address -> m [AccountDelegation]

Obtain information about the delegation of a specific account.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountDelegations' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AccountDelegation]

Obtain information about the delegation of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountRegistrations :: MonadBlockfrost m => Address -> m [AccountRegistration]

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

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountRegistrations' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AccountRegistration]

Obtain information about the registrations and deregistrations of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountWithdrawals :: MonadBlockfrost m => Address -> m [AccountWithdrawal]

Obtain information about the withdrawals of a specific account.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountWithdrawals' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AccountWithdrawal]

Obtain information about the withdrawals of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountMirs :: MonadBlockfrost m => Address -> m [AccountMir]

Obtain information about the MIRs of a specific account.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountMirs' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AccountMir]

Obtain information about the MIRs of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountAssociatedAddresses :: MonadBlockfrost m => Address -> m [AddressAssociated]

Obtain information about the addresses of a specific account.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountAssociatedAddresses' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AddressAssociated]

Obtain information about the addresses of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAccountAssociatedAssets :: MonadBlockfrost m => Address -> m [Amount]

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

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAccountAssociatedAssets' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [Amount]

Obtain information about assets associated with addresses of a specific account. Allows custom paging and ordering using Paged and SortOrder.

getAddressInfo :: MonadBlockfrost m => Address -> m AddressInfo

Obtain information about a specific address.

getAddressDetails :: MonadBlockfrost m => Address -> m AddressDetails

Obtain details about an address.

getAddressUtxos :: MonadBlockfrost m => Address -> m [AddressUtxo]

UTXOs of the address.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAddressUtxos' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [AddressUtxo]

UTXOs of the address. Allows custom paging and ordering using Paged and SortOrder.

getAddressUtxosAsset :: MonadBlockfrost m => Address -> AssetId -> m [AddressUtxo]

UTXOs of the address containing specific asset.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAddressUtxosAsset' :: MonadBlockfrost m => Address -> AssetId -> Paged -> SortOrder -> m [AddressUtxo]

UTXOs of the address containing specific asset. Allows custom paging and ordering using Paged and SortOrder.

getAddressTransactions :: MonadBlockfrost m => Address -> m [AddressTransaction]

Transactions on the address.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAddressTransactions' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> Maybe BlockIndex -> Maybe BlockIndex -> m [AddressTransaction]

Transactions on the address. Allows custom paging and ordering using Paged and SortOrder. Also allows support for limiting block ranges using from/to BlockIndexes.

getAssets :: MonadBlockfrost m => m [AssetInfo]

List all assets

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAssets' :: MonadBlockfrost m => Paged -> SortOrder -> m [AssetInfo]

List all assets Allows custom paging and ordering using Paged and SortOrder.

getAssetDetails :: MonadBlockfrost m => AssetId -> m AssetDetails

Information about a specific asset

getAssetHistory :: MonadBlockfrost m => AssetId -> m [AssetHistory]

History of a specific asset

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAssetHistory' :: MonadBlockfrost m => AssetId -> Paged -> SortOrder -> m [AssetHistory]

History of a specific asset Allows custom paging and ordering using Paged and SortOrder.

getAssetTransactions :: MonadBlockfrost m => AssetId -> m [AssetTransaction]

List of a specific asset transactions

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAssetTransactions' :: MonadBlockfrost m => AssetId -> Paged -> SortOrder -> m [AssetTransaction]

List of a specific asset transactions Allows custom paging and ordering using Paged and SortOrder.

getAssetAddresses :: MonadBlockfrost m => AssetId -> m [AssetAddress]

List of a addresses containing a specific asset

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAssetAddresses' :: MonadBlockfrost m => AssetId -> Paged -> SortOrder -> m [AssetAddress]

List of a addresses containing a specific asset Allows custom paging and ordering using Paged and SortOrder.

getAssetsByPolicy :: MonadBlockfrost m => PolicyId -> m [AssetInfo]

List of asset minted under a specific policy

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getAssetsByPolicy' :: MonadBlockfrost m => PolicyId -> Paged -> SortOrder -> m [AssetInfo]

List of asset minted under a specific policy Allows custom paging and ordering using Paged and SortOrder.

getLatestBlock :: MonadBlockfrost m => m Block

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

getLatestBlockTxs :: MonadBlockfrost m => m [TxHash]

Return the transactions within the latest block.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getLatestBlockTxs' :: MonadBlockfrost m => Paged -> SortOrder -> m [TxHash]

Return the transactions within the latest block. Allows custom paging and ordering using Paged and SortOrder.

getBlock :: MonadBlockfrost m => Either Integer BlockHash -> m Block

Return the content of a requested block.

getBlockSlot :: MonadBlockfrost m => Slot -> m Block

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

getBlockEpochSlot :: MonadBlockfrost m => Epoch -> Slot -> m Block

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

getNextBlocks :: MonadBlockfrost m => Either Integer BlockHash -> m [Block]

Return the list of blocks following a specific block.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getNextBlocks' :: MonadBlockfrost m => Either Integer BlockHash -> Paged -> m [Block]

Return the list of blocks following a specific block. Allows custom paging using Paged.

getPreviousBlocks :: MonadBlockfrost m => Either Integer BlockHash -> m [Block]

Return the list of blocks preceding a specific block.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getPreviousBlocks' :: MonadBlockfrost m => Either Integer BlockHash -> Paged -> m [Block]

Return the list of blocks preceding a specific block. Allows custom paging using Paged.

getBlockTxs :: MonadBlockfrost m => Either Integer BlockHash -> m [TxHash]

Return the transactions within the block.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getBlockTxs' :: MonadBlockfrost m => Either Integer BlockHash -> Paged -> SortOrder -> m [TxHash]

Return the transactions within the block. Allows custom paging and ordering using Paged and SortOrder.

getBlockAffectedAddresses' :: MonadBlockfrost m => Either Integer BlockHash -> Paged -> m [(Address, [TxHash])]

Return list of addresses affected in the specified block with additional information, sorted by the bech32 address, ascending. Allows custom paging using Paged.

getBlockAffectedAddresses :: MonadBlockfrost m => Either Integer BlockHash -> m [(Address, [TxHash])]

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

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getLatestEpoch :: MonadBlockfrost m => m EpochInfo

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

getLatestEpochProtocolParams :: MonadBlockfrost m => m ProtocolParams

Get the protocol parameters for the latest epoch.

getEpoch :: MonadBlockfrost m => Epoch -> m EpochInfo

Get the information about specific epoch.

getNextEpochs :: MonadBlockfrost m => Epoch -> m [EpochInfo]

Return the list of epochs following a specific epoch.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getNextEpochs' :: MonadBlockfrost m => Epoch -> Paged -> m [EpochInfo]

Return the list of epochs following a specific epoch. Allows custom paging using Paged.

getPreviousEpochs :: MonadBlockfrost m => Epoch -> m [EpochInfo]

Return the list of epochs preceding a specific epoch.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getPreviousEpochs' :: MonadBlockfrost m => Epoch -> Paged -> m [EpochInfo]

Return the list of epochs preceding a specific epoch. Allows custom paging using Paged.

getEpochStake :: MonadBlockfrost m => Epoch -> m [StakeDistribution]

Return the active stake distribution for the specified epoch.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getEpochStake' :: MonadBlockfrost m => Epoch -> Paged -> m [StakeDistribution]

Return the active stake distribution for the specified epoch. Allows custom paging using Paged.

getEpochStakeByPool :: MonadBlockfrost m => Epoch -> PoolId -> m [PoolStakeDistribution]

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

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getEpochStakeByPool' :: MonadBlockfrost m => Epoch -> PoolId -> Paged -> m [PoolStakeDistribution]

Return the active stake distribution for the epoch specified by stake pool. Allows custom paging using Paged.

getEpochBlocks :: MonadBlockfrost m => Epoch -> m [BlockHash]

Return the blocks minted for the specified epoch.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getEpochBlocks' :: MonadBlockfrost m => Epoch -> Paged -> SortOrder -> m [BlockHash]

Return the blocks minted for the specified epoch. Allows custom paging and ordering using Paged and SortOrder.

getEpochBlocksByPool :: MonadBlockfrost m => Epoch -> PoolId -> m [BlockHash]

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

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getEpochBlocksByPool' :: MonadBlockfrost m => Epoch -> PoolId -> Paged -> SortOrder -> m [BlockHash]

Return the block minted for the epoch specified by stake pool. Allows custom paging and ordering using Paged and SortOrder.

getEpochProtocolParams :: MonadBlockfrost m => Epoch -> m ProtocolParams

Return the protocol parameters for the specified epoch.

getLedgerGenesis :: MonadBlockfrost m => m Genesis

Get the information about blockchain genesis.

getTxMetadataLabels :: MonadBlockfrost m => m [TxMeta]

List of all used transaction metadata labels.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getTxMetadataLabels' :: MonadBlockfrost m => Paged -> SortOrder -> m [TxMeta]

List of all used transaction metadata labels. Allows custom paging and ordering using Paged and SortOrder.

getTxMetadataByLabelJSON :: MonadBlockfrost m => Text -> m [TxMetaJSON]

Transaction metadata per label (JSON Value)

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getTxMetadataByLabelJSON' :: MonadBlockfrost m => Text -> Paged -> SortOrder -> m [TxMetaJSON]

Transaction metadata per label (JSON Value) Allows custom paging and ordering using Paged and SortOrder.

getTxMetadataByLabelCBOR :: MonadBlockfrost m => Text -> m [TxMetaCBOR]

Transaction metadata per label (CBOR ByteString)

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getTxMetadataByLabelCBOR' :: MonadBlockfrost m => Text -> Paged -> SortOrder -> m [TxMetaCBOR]

Transaction metadata per label (CBOR ByteString) Allows custom paging and ordering using Paged and SortOrder.

getNetworkInfo :: MonadBlockfrost m => m Network

Get detailed network information.

getNetworkEras :: MonadBlockfrost m => m [NetworkEraSummary]

Get summarized information on each era in the network, including start, end, and variable era parameters.

listPools :: MonadBlockfrost m => m [PoolId]

List registered stake pools.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

listPools' :: MonadBlockfrost m => Paged -> SortOrder -> m [PoolId]

List registered stake pools. Allows custom paging and ordering using Paged and SortOrder.

listRetiredPools :: MonadBlockfrost m => m [PoolEpoch]

List retired stake pools.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

listRetiredPools' :: MonadBlockfrost m => Paged -> SortOrder -> m [PoolEpoch]

List retired stake pools. Allows custom paging and ordering using Paged and SortOrder.

listRetiringPools :: MonadBlockfrost m => m [PoolEpoch]

List retiring stake pools.

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

listRetiringPools' :: MonadBlockfrost m => Paged -> SortOrder -> m [PoolEpoch]

List retiring stake pools. Allows custom paging and ordering using Paged and SortOrder.

getPool :: MonadBlockfrost m => PoolId -> m PoolInfo

Get specific stake pool information

getPoolHistory :: MonadBlockfrost m => PoolId -> m [PoolHistory]

Get stake pool history

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getPoolHistory' :: MonadBlockfrost m => PoolId -> Paged -> SortOrder -> m [PoolHistory]

Get stake pool history Allows custom paging and ordering using Paged and SortOrder.

getPoolMetadata :: MonadBlockfrost m => PoolId -> m (Maybe PoolMetadata)

Get stake pool metadata

getPoolRelays :: MonadBlockfrost m => PoolId -> m [PoolRelay]

Get stake pool relays

getPoolDelegators :: MonadBlockfrost m => PoolId -> m [PoolDelegator]

Get stake pool delegators

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getPoolDelegators' :: MonadBlockfrost m => PoolId -> Paged -> SortOrder -> m [PoolDelegator]

Get stake pool delegators Allows custom paging and ordering using Paged and SortOrder.

getPoolBlocks :: MonadBlockfrost m => PoolId -> m [BlockHash]

Get stake pool blocks

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getPoolBlocks' :: MonadBlockfrost m => PoolId -> Paged -> SortOrder -> m [BlockHash]

Get stake pool blocks Allows custom paging and ordering using Paged and SortOrder.

getPoolUpdates :: MonadBlockfrost m => PoolId -> m [PoolUpdate]

Get stake pool updates

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getPoolUpdates' :: MonadBlockfrost m => PoolId -> Paged -> SortOrder -> m [PoolUpdate]

Get stake pool updates Allows custom paging and ordering using Paged and SortOrder.

listScripts :: MonadBlockfrost m => m ScriptHashList

List scripts

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

listScripts' :: MonadBlockfrost m => Paged -> SortOrder -> m ScriptHashList

List scripts Allows custom paging and ordering using Paged and SortOrder.

getScript :: MonadBlockfrost m => ScriptHash -> m Script

Get specific script information

getScriptRedeemers :: MonadBlockfrost m => ScriptHash -> m [ScriptRedeemer]

Get redeemers of a specific script

Queries 100 entries. To query all entries use allPages with principled variant of this function (suffixed with ') that accepts Paged argument.

getScriptRedeemers' :: MonadBlockfrost m => ScriptHash -> Paged -> SortOrder -> m [ScriptRedeemer]

Get redeemers of a specific script Allows custom paging and ordering using Paged and SortOrder.

getScriptDatum :: MonadBlockfrost m => DatumHash -> m ScriptDatum

Get specific datum

getScriptDatumCBOR :: MonadBlockfrost m => DatumHash -> m ScriptDatumCBOR

Get specific datum

getScriptJSON :: MonadBlockfrost m => ScriptHash -> m ScriptJSON

Get a JSON representation of a timelock script

getScriptCBOR :: MonadBlockfrost m => ScriptHash -> m ScriptCBOR

Get a CBOR representation of a plutus script

getTx :: MonadBlockfrost m => TxHash -> m Transaction

Get specific transaction

getTxUtxos :: MonadBlockfrost m => TxHash -> m TransactionUtxos

Get transaction UTXOs

getTxStakes :: MonadBlockfrost m => TxHash -> m [TransactionStake]

Get (de-)registrations of a stake address within a transaction

getTxDelegations :: MonadBlockfrost m => TxHash -> m [TransactionDelegation]

Get transaction delegation certificates

getTxWithdrawals :: MonadBlockfrost m => TxHash -> m [TransactionWithdrawal]

Get transaction withdrawals

getTxMirs :: MonadBlockfrost m => TxHash -> m [TransactionMir]

Get transaction MIRs (Move Instantaneous Rewards)

getTxPoolUpdates :: MonadBlockfrost m => TxHash -> m [TransactionPoolUpdate]

Get transaction stake pool registration and update certificates

getTxPoolRetiring :: MonadBlockfrost m => TxHash -> m [TransactionPoolRetiring]

Get transaction stake pool retirement certificates

getTxMetadataJSON :: MonadBlockfrost m => TxHash -> m [TransactionMetaJSON]

Get transaction metadata in JSON

getTxMetadataCBOR :: MonadBlockfrost m => TxHash -> m [TransactionMetaCBOR]

Get transaction metadata in CBOR

getTxRedeemers :: MonadBlockfrost m => TxHash -> m [TransactionRedeemer]

Get transaction redeemers

submitTx :: MonadBlockfrost m => CBORString -> m TxHash

Submit an already serialized transaction to the network.

ipfsAdd :: (MonadError BlockfrostError m, MonadBlockfrost m) => FilePath -> m IPFSAdd

Add a file or directory to IPFS

ipfsGateway :: MonadBlockfrost m => Text -> m IPFSData

Fetch file via API

ipfsGetPin :: MonadBlockfrost m => Text -> m IPFSPin

Get pinned object details

ipfsListPins :: MonadBlockfrost m => m [IPFSPin]

List objects pinned to local storage

ipfsListPins' :: MonadBlockfrost m => Paged -> SortOrder -> m [IPFSPin]

List objects pinned to local storage Allows custom paging and ordering using Paged and SortOrder.

ipfsPin :: MonadBlockfrost m => Text -> m IPFSPinChange

Pin an object

ipfsRemovePin :: MonadBlockfrost m => Text -> m IPFSPinChange

Remove pinned object from local storage

nutlinkListAddress :: MonadBlockfrost m => Address -> m NutlinkAddress

List metadata about specific address

nutlinkListAddressTickers :: MonadBlockfrost m => Address -> m [NutlinkAddressTicker]

List tickers for a specific metadata oracle

nutlinkListAddressTickers' :: MonadBlockfrost m => Address -> Paged -> SortOrder -> m [NutlinkAddressTicker]

List tickers for a specific metadata oracle Allows custom paging and ordering using Paged and SortOrder.

nutlinkAddressTickers :: MonadBlockfrost m => Address -> Text -> m [NutlinkTicker]

List of records of a specific ticker

nutlinkAddressTickers' :: MonadBlockfrost m => Address -> Text -> Paged -> SortOrder -> m [NutlinkTicker]

List of records of a specific ticker Allows custom paging and ordering using Paged and SortOrder.

nutlinkTickers :: MonadBlockfrost m => Text -> m [(Address, NutlinkTicker)]

List of records of a specific ticker

nutlinkTickers' :: MonadBlockfrost m => Text -> Paged -> SortOrder -> m [(Address, NutlinkTicker)]

List of records of a specific ticker Allows custom paging and ordering using Paged and SortOrder.