API Reference

28min

Blockchain Indexer API

Accounts

Title

Endpoint

Description

/accounts/{stake_addr}

Returns various information regarding a stake account

/accounts/{stake_addr}/addresses

Returns a list of addresses seen on-chain using the specified stake key

/accounts/{stake_addr}/assets

Returns a list of native assets owned by addresses with the specified stake key

/accounts/{stake_addr}/delegations

Returns a list of delegation actions related to a stake account

/accounts/{stake_addr}/history

Returns per-epoch history for the specified stake key

/accounts/{stake_addr}/rewards

Returns a list of staking-related rewards for the specified stake key

/accounts/{stake_addr}/updates

Returns a list of updates relating to the specified stake key (registration, deregistration, etc.)



Addresses

Title

Endpoint

Description

/addresses/cred/transactions

Returns transactions where any of the specified payment credentials were used.

/addresses/cred/utxos

Returns detailed UTxOs controlled by a list of payment credentials.

/addresses/cred/{credential}/balance

Returns the total amount of assets, including ADA, controlled by a payment credential.

/addresses/cred/{credential}/transactions

Returns transactions where a specific payment credential was used.

/addresses/cred/{credential}/utxos

Returns detailed UTxOs controlled by a specific payment credential.

/addresses/utxos

Returns detailed UTxOs controlled by addresses in a list.

/addresses/{address}/decode

Decodes the encoded information within a Cardano address.

/addresses/{address}/transactions

Returns transactions where the specified address was used.

/addresses/{address}/transactions/count

Returns the number of transactions where the address was used.

/addresses/{address}/utxo_refs

Returns references (transaction hash and output index) for UTxOs controlled by an address.

/addresses/{address}/utxos

Returns detailed UTxOs controlled by a specific address.



Assets

Title

Endpoint

Description

/assets/{asset}

Returns a summary of information about a specific asset.

/assets/{asset}/accounts

Returns a list of accounts associated with addresses that control some of the specified asset.

/assets/{asset}/addresses

Returns a list of addresses that control some amount of the specified asset.

/assets/{asset}/mints

Returns a list of transactions where the specified asset was minted or burned.

/assets/{asset}/transactions

Returns a list of transactions involving the movement or minting of the specified asset.

/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

/blocks/latest

Returns information about the most recently minted block.

/blocks/{hash_or_height}

Returns information about the specified block by its height or hash.



General

Title

Endpoint

Description

/system-start

Returns the blockchain system start time.

/protocol-parameters

Returns the current blockchain protocol parameters.

/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

Returns the datums corresponding to the specified datum hashes if they have been seen on-chain.

/datums/{datum_hash}

Returns the datum corresponding to the specified datum hash if it has been seen on-chain.

Ecosystem

Title

Endpoint

Description

/ecosystem/adahandle/{handle}

Returns the Cardano address corresponding to an ADA Handle.

Epochs

Title

Endpoint

Description

/epochs/current

Returns a summary of information about the current epoch.

/epochs/{epoch_no}

Returns a summary of information about a specific epoch.



Asset Policy

Title

Endpoint

Description

/policy/{policy}

Returns a summary of information about a native asset policy ID and assets minted under that policy.

/policy/{policy}/accounts

Returns a list of accounts associated with addresses that control assets under the specified policy.

/policy/{policy}/addresses

Returns a list of addresses that hold assets under the specified policy ID.

/policy/{policy}/assets

Lists all assets under the specified policy with a brief summary for each.

/policy/{policy}/mints

Returns a list of transactions where assets under the specified policy were minted or burned.

/policy/{policy}/transactions

Returns transactions involving assets of the specified 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

/pools

Returns a list of currently registered stake pools.

/pools/{pool_id}/blocks

Returns information about blocks minted by a given pool for all epochs or a specific epoch.

/pools/{pool_id}/delegators

Returns a list of delegators of the specified pool.

/pools/{pool_id}/delegators/{epoch_no}

Returns a list of delegators of a pool as of a certain epoch.

/pools/{pool_id}/history

Returns per-epoch information about the specified pool or just for a specific epoch.

/pools/{pool_id}/info

Returns current information about the specified pool.

/pools/{pool_id}/metadata

Returns the metadata declared on-chain by the specified stake pool.

/pools/{pool_id}/relays

Returns a list of relays declared on-chain by the specified stake pool.

/pools/{pool_id}/updates

Returns a list of updates relating to the specified pool.



Scripts

Title

Endpoint

Description

/scripts/{script_hash}

Returns the script corresponding to the specified script hash, if seen on-chain.



Transactions

Title

Endpoint

Description

/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.

/transactions/outputs

Returns specified transaction outputs. Can handle missing outputs via the allow_missing parameter, and can paginate results with optional CBOR encoding.

/transactions/{tx_hash}

Retrieves detailed information about a specific transaction using the transaction hash.

/transactions/{tx_hash}/cbor

Returns hex-encoded CBOR bytes of a transaction identified by its transaction hash.

/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.

/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

/txmanager

Submit an already serialized transaction to the Cardano network.

/txmanager/{txhash}/state

Fetch the current state of a transaction using its transaction hash.

/txmanager/history

Retrieve a paginated list of historical transactions.



Transaction Manager

Title

Endpoint

Description

/txmanager/turbosubmit





Webhooks

Title

Endpoint

Description

/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.

/markets/dexs/ohlc/{dex}/{pair}

Returns market activity in candlestick OHLC format for a specific DEX and token pair.

/markets/dexs/stats/{dex}/{pair}

Returns DEX and token pair statistics over different time ranges.

/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

/contracts/vesting/lock

Lock assets into the vesting contract.

/contracts/vesting/collect/{beneficiary}

Collect assets from the vesting contract.

/contracts/vesting/state/{beneficiary}

Detailed list of vesting assets at a beneficiary address.



Direct Swap

Title

Endpoint

Description

/contracts/directSwap/createOffer

Create a new offer for direct swap.

/contracts/directSwap/cancelOffer

Cancel an existing offer for direct swap.

/contracts/directSwap/getOffers

Get all the existing offers for direct swap.

/contracts/directSwap/getOffers/{address}

Get all the existing offers for a specific user.

/contracts/directSwap/fillOffer

Fill an existing offer for direct swap.



Updated 11 Oct 2024
Doc contributor
Did this page help you?