API Reference

28min

﻿Blockchain Indexer API﻿
﻿Transaction Manager API 
﻿Market Price API 
﻿Managed Contracts API 
Turbo Transaction
Blockchain Indexer API
Accounts 
Title
Endpoint
Description
﻿Stake Account Information﻿
/accounts/{stake_addr}
Returns various information regarding a stake account
﻿Stake Account Addresses﻿
/accounts/{stake_addr}/addresses
Returns a list of addresses seen on-chain using the specified stake key
﻿Stake Account Assets﻿
/accounts/{stake_addr}/assets
Returns a list of native assets owned by addresses with the specified stake key
﻿Stake Account Delegation History﻿
/accounts/{stake_addr}/delegations
Returns a list of delegation actions related to a stake account
﻿Stake Account History﻿
/accounts/{stake_addr}/history
Returns per-epoch history for the specified stake key
﻿Stake Account Rewards﻿
/accounts/{stake_addr}/rewards
Returns a list of staking-related rewards for the specified stake key
﻿Stake Account Updates﻿
/accounts/{stake_addr}/updates
Returns a list of updates relating to the specified stake key (registration, deregistration, etc.)
﻿
Addresses
Title
Endpoint
Description
﻿Transactions by multiple payment credentials﻿
/addresses/cred/transactions
Returns transactions where any of the specified payment credentials were used.
﻿UTxOs by multiple payment credentials﻿
/addresses/cred/utxos
Returns detailed UTxOs controlled by a list of payment credentials.
﻿Balance by payment credential﻿
/addresses/cred/{credential}/balance
Returns the total amount of assets, including ADA, controlled by a payment credential.
﻿Payment credential transactions﻿
/addresses/cred/{credential}/transactions
Returns transactions where a specific payment credential was used.
﻿UTxOs by payment credential﻿
/addresses/cred/{credential}/utxos
Returns detailed UTxOs controlled by a specific payment credential.
﻿UTxOs by multiple addresses﻿
/addresses/utxos
Returns detailed UTxOs controlled by addresses in a list.
﻿Decode address﻿
/addresses/{address}/decode
Decodes the encoded information within a Cardano address.
﻿Address transactions﻿
/addresses/{address}/transactions
Returns transactions where the specified address was used.
﻿Address transaction count﻿
/addresses/{address}/transactions/count
Returns the number of transactions where the address was used.
﻿UTxO references at an address﻿
/addresses/{address}/utxo_refs
Returns references (transaction hash and output index) for UTxOs controlled by an address.
﻿UTxOs at an address﻿
/addresses/{address}/utxos
Returns detailed UTxOs controlled by a specific address.
﻿
Assets
Title
Endpoint
Description
﻿Native asset information﻿
/assets/{asset}
Returns a summary of information about a specific asset.
﻿Accounts of addresses holding specific asset﻿
/assets/{asset}/accounts
Returns a list of accounts associated with addresses that control some of the specified asset.
﻿Native asset addresses﻿
/assets/{asset}/addresses
Returns a list of addresses that control some amount of the specified asset.
﻿Native asset mints and burns﻿
/assets/{asset}/mints
Returns a list of transactions where the specified asset was minted or burned.
﻿Native asset transactions﻿
/assets/{asset}/transactions
Returns a list of transactions involving the movement or minting of the specified asset.
﻿Native asset UTxOs﻿
/assets/{asset}/utxos
Returns references for UTxOs that contain the specified asset, paired with the amount of the asset in the UTxO.
﻿
Blocks
Title
Endpoint
Description
﻿Latest block information﻿
/blocks/latest
Returns information about the most recently minted block.
﻿Block information﻿
/blocks/{hash_or_height}
Returns information about the specified block by its height or hash.
﻿
General
Title
Endpoint
Description
﻿Blockchain system start﻿
/system-start
Returns the blockchain system start time.
﻿Protocol parameters﻿
/protocol-parameters
Returns the current blockchain protocol parameters.
﻿Era summary﻿
/era-summaries
Returns the blockchain era summary.
﻿Chain-tip﻿
/chain-tip
Returns the identifier of the most recently processed block on the network.
﻿
Datums
Title
Endpoint
Description
﻿Datums by hashes﻿
/datums
Returns the datums corresponding to the specified datum hashes if they have been seen on-chain.
﻿Datum by datum hash﻿
/datums/{datum_hash}
Returns the datum corresponding to the specified datum hash if it has been seen on-chain.
Ecosystem
Title
Endpoint
Description
﻿Resolve ADA Handle﻿
/ecosystem/adahandle/{handle}
Returns the Cardano address corresponding to an ADA Handle.
Epochs
Title
Endpoint
Description
﻿Current epoch details﻿
/epochs/current
Returns a summary of information about the current epoch.
﻿Specific epoch details﻿
/epochs/{epoch_no}
Returns a summary of information about a specific epoch.
﻿
Asset Policy
Title
Endpoint
Description
﻿Information about a policy of native assets﻿
/policy/{policy}
Returns a summary of information about a native asset policy ID and assets minted under that policy.
﻿Accounts holding assets of specific policy﻿
/policy/{policy}/accounts
Returns a list of accounts associated with addresses that control assets under the specified policy.
﻿Addresses holding assets of specific policy﻿
/policy/{policy}/addresses
Returns a list of addresses that hold assets under the specified policy ID.
﻿List assets of a policy﻿
/policy/{policy}/assets
Lists all assets under the specified policy with a brief summary for each.
﻿Transactions minting or burning assets of policy﻿
/policy/{policy}/mints
Returns a list of transactions where assets under the specified policy were minted or burned.
﻿Transactions involving assets of policy﻿
/policy/{policy}/transactions
Returns transactions involving assets of the specified policy.
﻿UTxOs containing assets of specific policy﻿
/policy/{policy}/utxos
Returns UTxOs that contain assets of the specified policy, paired with the asset names and amounts in the UTxO.
﻿
Pools
Title
Endpoint
Description
﻿List registered stake pools﻿
/pools
Returns a list of currently registered stake pools.
﻿Stake pool blocks﻿
/pools/{pool_id}/blocks
Returns information about blocks minted by a given pool for all epochs or a specific epoch.
﻿Stake pool delegators﻿
/pools/{pool_id}/delegators
Returns a list of delegators of the specified pool.
﻿Stake pool delegator history﻿
/pools/{pool_id}/delegators/{epoch_no}
Returns a list of delegators of a pool as of a certain epoch.
﻿Stake pool history﻿
/pools/{pool_id}/history
Returns per-epoch information about the specified pool or just for a specific epoch.
﻿Stake pool information﻿
/pools/{pool_id}/info
Returns current information about the specified pool.
﻿Stake pool metadata﻿
/pools/{pool_id}/metadata
Returns the metadata declared on-chain by the specified stake pool.
﻿Stake pool relays﻿
/pools/{pool_id}/relays
Returns a list of relays declared on-chain by the specified stake pool.
﻿Stake pool updates﻿
/pools/{pool_id}/updates
Returns a list of updates relating to the specified pool.
﻿
Scripts
Title
Endpoint
Description
﻿Script by script hash﻿
/scripts/{script_hash}
Returns the script corresponding to the specified script hash, if seen on-chain.
﻿
Transactions
Title
Endpoint
Description
﻿Evaluate redeemers of a transaction﻿
/transactions/evaluate
Evaluates the redeemers of a transaction to compute execution units required for each, without submitting to the chain. Useful during transaction building to estimate budgets for redeemers.
﻿Transaction outputs by output references﻿
/transactions/outputs
Returns specified transaction outputs. Can handle missing outputs via the allow_missing parameter, and can paginate results with optional CBOR encoding.
﻿Transaction details﻿
/transactions/{tx_hash}
Retrieves detailed information about a specific transaction using the transaction hash.
﻿CBOR bytes of a transaction﻿
/transactions/{tx_hash}/cbor
Returns hex-encoded CBOR bytes of a transaction identified by its transaction hash.
﻿Address by transaction output reference﻿
/transactions/{tx_hash}/outputs/{index}/address
Returns the address specified in the given transaction output reference. Only returns results for collateral return output if the transaction is invalid.
﻿Transaction output by output reference﻿
/transactions/{tx_hash}/outputs/{index}/txo
Retrieves a transaction output, resolving datum hash if present, using the transaction hash and output index. Optional CBOR encoding can be included in the response.
﻿
Transaction Manager API
Transactions
Title
Endpoint
Description
﻿Submit a Transaction﻿
/txmanager
Submit an already serialized transaction to the Cardano network.
﻿Get Transaction State﻿
/txmanager/{txhash}/state
Fetch the current state of a transaction using its transaction hash.
﻿Transaction History﻿
/txmanager/history
Retrieve a paginated list of historical transactions.
﻿
Transaction Manager
Title
Endpoint
Description
﻿Turbo Transaction﻿
/txmanager/turbosubmit
﻿
﻿
Webhooks
Title
Endpoint
Description
﻿Create a Webhook﻿
/webhooks/project/{project_id}
Set up a new webhook for transaction monitoring.
﻿
Market Price API
DEX
Title
Endpoint
Description
﻿DEXs﻿
/markets/dexs
Returns all available DEXs.
﻿DEX and Pair OHLC﻿
/markets/dexs/ohlc/{dex}/{pair}
Returns market activity in candlestick OHLC format for a specific DEX and token pair.
﻿DEX and Pair Stats﻿
/markets/dexs/stats/{dex}/{pair}
Returns DEX and token pair statistics over different time ranges.
﻿DEX and Pair Trades﻿
/markets/dexs/trades/{dex}/{pair}
Returns raw trades for a specific DEX and token pair.
﻿DEX Pairs﻿
/markets/dexs/{dex}
Returns available pairs for a given DEX.
﻿
Managed Contracts API
Vesting 
Title
Endpoint
Description
﻿Lock assets﻿
/contracts/vesting/lock
Lock assets into the vesting contract.
﻿Collect assets﻿
/contracts/vesting/collect/{beneficiary}
Collect assets from the vesting contract.
﻿State of vesting assets﻿
/contracts/vesting/state/{beneficiary}
Detailed list of vesting assets at a beneficiary address.
﻿
Direct Swap
Title
Endpoint
Description
﻿Create an offer﻿
/contracts/directSwap/createOffer
Create a new offer for direct swap.
﻿Cancel an offer﻿
/contracts/directSwap/cancelOffer
Cancel an existing offer for direct swap.
﻿Get all offers﻿
/contracts/directSwap/getOffers
Get all the existing offers for direct swap.
﻿Get user's offers﻿
/contracts/directSwap/getOffers/{address}
Get all the existing offers for a specific user.
﻿Fill an offer﻿
/contracts/directSwap/fillOffer
Fill an existing offer for direct swap.
﻿

Title	Endpoint	Description
Stake Account Information	/accounts/{stake_addr}	Returns various information regarding a stake account
Stake Account Addresses	/accounts/{stake_addr}/addresses	Returns a list of addresses seen on-chain using the specified stake key
Stake Account Assets	/accounts/{stake_addr}/assets	Returns a list of native assets owned by addresses with the specified stake key
Stake Account Delegation History	/accounts/{stake_addr}/delegations	Returns a list of delegation actions related to a stake account
Stake Account History	/accounts/{stake_addr}/history	Returns per-epoch history for the specified stake key
Stake Account Rewards	/accounts/{stake_addr}/rewards	Returns a list of staking-related rewards for the specified stake key
Stake Account Updates	/accounts/{stake_addr}/updates	Returns a list of updates relating to the specified stake key (registration, deregistration, etc.)

Title	Endpoint	Description
Transactions by multiple payment credentials	/addresses/cred/transactions	Returns transactions where any of the specified payment credentials were used.
UTxOs by multiple payment credentials	/addresses/cred/utxos	Returns detailed UTxOs controlled by a list of payment credentials.
Balance by payment credential	/addresses/cred/{credential}/balance	Returns the total amount of assets, including ADA, controlled by a payment credential.
Payment credential transactions	/addresses/cred/{credential}/transactions	Returns transactions where a specific payment credential was used.
UTxOs by payment credential	/addresses/cred/{credential}/utxos	Returns detailed UTxOs controlled by a specific payment credential.
UTxOs by multiple addresses	/addresses/utxos	Returns detailed UTxOs controlled by addresses in a list.
Decode address	/addresses/{address}/decode	Decodes the encoded information within a Cardano address.
Address transactions	/addresses/{address}/transactions	Returns transactions where the specified address was used.
Address transaction count	/addresses/{address}/transactions/count	Returns the number of transactions where the address was used.
UTxO references at an address	/addresses/{address}/utxo_refs	Returns references (transaction hash and output index) for UTxOs controlled by an address.
UTxOs at an address	/addresses/{address}/utxos	Returns detailed UTxOs controlled by a specific address.

Title	Endpoint	Description
Native asset information	/assets/{asset}	Returns a summary of information about a specific asset.
Accounts of addresses holding specific asset	/assets/{asset}/accounts	Returns a list of accounts associated with addresses that control some of the specified asset.
Native asset addresses	/assets/{asset}/addresses	Returns a list of addresses that control some amount of the specified asset.
Native asset mints and burns	/assets/{asset}/mints	Returns a list of transactions where the specified asset was minted or burned.
Native asset transactions	/assets/{asset}/transactions	Returns a list of transactions involving the movement or minting of the specified asset.
Native asset UTxOs	/assets/{asset}/utxos	Returns references for UTxOs that contain the specified asset, paired with the amount of the asset in the UTxO.

Title	Endpoint	Description
Latest block information	/blocks/latest	Returns information about the most recently minted block.
Block information	/blocks/{hash_or_height}	Returns information about the specified block by its height or hash.

Title	Endpoint	Description
Blockchain system start	/system-start	Returns the blockchain system start time.
Protocol parameters	/protocol-parameters	Returns the current blockchain protocol parameters.
Era summary	/era-summaries	Returns the blockchain era summary.
Chain-tip	/chain-tip	Returns the identifier of the most recently processed block on the network.

Title	Endpoint	Description
Datums by hashes	/datums	Returns the datums corresponding to the specified datum hashes if they have been seen on-chain.
Datum by datum hash	/datums/{datum_hash}	Returns the datum corresponding to the specified datum hash if it has been seen on-chain.

Title	Endpoint	Description
Resolve ADA Handle	/ecosystem/adahandle/{handle}	Returns the Cardano address corresponding to an ADA Handle.

Title	Endpoint	Description
Current epoch details	/epochs/current	Returns a summary of information about the current epoch.
Specific epoch details	/epochs/{epoch_no}	Returns a summary of information about a specific epoch.

Title	Endpoint	Description
Information about a policy of native assets	/policy/{policy}	Returns a summary of information about a native asset policy ID and assets minted under that policy.
Accounts holding assets of specific policy	/policy/{policy}/accounts	Returns a list of accounts associated with addresses that control assets under the specified policy.
Addresses holding assets of specific policy	/policy/{policy}/addresses	Returns a list of addresses that hold assets under the specified policy ID.
List assets of a policy	/policy/{policy}/assets	Lists all assets under the specified policy with a brief summary for each.
Transactions minting or burning assets of policy	/policy/{policy}/mints	Returns a list of transactions where assets under the specified policy were minted or burned.
Transactions involving assets of policy	/policy/{policy}/transactions	Returns transactions involving assets of the specified policy.
UTxOs containing assets of specific policy	/policy/{policy}/utxos	Returns UTxOs that contain assets of the specified policy, paired with the asset names and amounts in the UTxO.

Title	Endpoint	Description
List registered stake pools	/pools	Returns a list of currently registered stake pools.
Stake pool blocks	/pools/{pool_id}/blocks	Returns information about blocks minted by a given pool for all epochs or a specific epoch.
Stake pool delegators	/pools/{pool_id}/delegators	Returns a list of delegators of the specified pool.
Stake pool delegator history	/pools/{pool_id}/delegators/{epoch_no}	Returns a list of delegators of a pool as of a certain epoch.
Stake pool history	/pools/{pool_id}/history	Returns per-epoch information about the specified pool or just for a specific epoch.
Stake pool information	/pools/{pool_id}/info	Returns current information about the specified pool.
Stake pool metadata	/pools/{pool_id}/metadata	Returns the metadata declared on-chain by the specified stake pool.
Stake pool relays	/pools/{pool_id}/relays	Returns a list of relays declared on-chain by the specified stake pool.
Stake pool updates	/pools/{pool_id}/updates	Returns a list of updates relating to the specified pool.

Title	Endpoint	Description
Script by script hash	/scripts/{script_hash}	Returns the script corresponding to the specified script hash, if seen on-chain.

Title	Endpoint	Description
Evaluate redeemers of a transaction	/transactions/evaluate	Evaluates the redeemers of a transaction to compute execution units required for each, without submitting to the chain. Useful during transaction building to estimate budgets for redeemers.
Transaction outputs by output references	/transactions/outputs	Returns specified transaction outputs. Can handle missing outputs via the allow_missing parameter, and can paginate results with optional CBOR encoding.
Transaction details	/transactions/{tx_hash}	Retrieves detailed information about a specific transaction using the transaction hash.
CBOR bytes of a transaction	/transactions/{tx_hash}/cbor	Returns hex-encoded CBOR bytes of a transaction identified by its transaction hash.
Address by transaction output reference	/transactions/{tx_hash}/outputs/{index}/address	Returns the address specified in the given transaction output reference. Only returns results for collateral return output if the transaction is invalid.
Transaction output by output reference	/transactions/{tx_hash}/outputs/{index}/txo	Retrieves a transaction output, resolving datum hash if present, using the transaction hash and output index. Optional CBOR encoding can be included in the response.

Title	Endpoint	Description
Submit a Transaction	/txmanager	Submit an already serialized transaction to the Cardano network.
Get Transaction State	/txmanager/{txhash}/state	Fetch the current state of a transaction using its transaction hash.
Transaction History	/txmanager/history	Retrieve a paginated list of historical transactions.

Title	Endpoint	Description
Turbo Transaction	/txmanager/turbosubmit

Title	Endpoint	Description
Create a Webhook	/webhooks/project/{project_id}	Set up a new webhook for transaction monitoring.

Title	Endpoint	Description
DEXs	/markets/dexs	Returns all available DEXs.
DEX and Pair OHLC	/markets/dexs/ohlc/{dex}/{pair}	Returns market activity in candlestick OHLC format for a specific DEX and token pair.
DEX and Pair Stats	/markets/dexs/stats/{dex}/{pair}	Returns DEX and token pair statistics over different time ranges.
DEX and Pair Trades	/markets/dexs/trades/{dex}/{pair}	Returns raw trades for a specific DEX and token pair.
DEX Pairs	/markets/dexs/{dex}	Returns available pairs for a given DEX.

Title	Endpoint	Description
Lock assets	/contracts/vesting/lock	Lock assets into the vesting contract.
Collect assets	/contracts/vesting/collect/{beneficiary}	Collect assets from the vesting contract.
State of vesting assets	/contracts/vesting/state/{beneficiary}	Detailed list of vesting assets at a beneficiary address.

Title	Endpoint	Description
Create an offer	/contracts/directSwap/createOffer	Create a new offer for direct swap.
Cancel an offer	/contracts/directSwap/cancelOffer	Cancel an existing offer for direct swap.
Get all offers	/contracts/directSwap/getOffers	Get all the existing offers for direct swap.
Get user's offers	/contracts/directSwap/getOffers/{address}	Get all the existing offers for a specific user.
Fill an offer	/contracts/directSwap/fillOffer	Fill an existing offer for direct swap.

Updated 22 Nov 2024

Did this page help you?

API Usage

SDKs

API Reference

﻿Blockchain Indexer API﻿

﻿Transaction Manager API

﻿Market Price API

﻿Managed Contracts API

Turbo Transaction

Blockchain Indexer API

Accounts

Addresses

Assets

Blocks

General

Datums

Ecosystem

Epochs

Asset Policy

Pools

Scripts

Transactions

Transaction Manager API

Transactions

Transaction Manager

Webhooks

Market Price API

DEX

Managed Contracts API

Vesting

Direct Swap

Blockchain Indexer API

Transaction Manager API

Market Price API

Managed Contracts API