Algorand - REST API

REST API endpoints supported on Algorand Mainnet and Algorand Testnet through Tatum RPC Gateway, with base URLs and an example request.

Call Algorand REST endpoints through Tatum RPC Gateway. Append the endpoint path to the network's base URL and send your API key in the x-api-key header. See Authentication.

Algorand has 2 REST API interfaces, each with its own base URLs and endpoints: Algod and Indexer.

Algod

Base URLs

NetworkBase URL
Algorand Mainnethttps://algorand-mainnet-algod.gateway.tatum.io
Algorand Testnethttps://algorand-testnet-algod.gateway.tatum.io

Example request

curl 'https://algorand-mainnet-algod.gateway.tatum.io/v2/status' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

26 endpoints. Parameters and responses are described in the Algorand algod REST API reference; linked method names go to their page there.

EndpointDescription
GET /genesisReturns the genesis file in JSON.
GET /healthReturns the health status of the service.
GET /readyReturns OK when the node is healthy and fully caught up.
GET /v2/accounts/{account-id}Returns account information, including balance and status.
GET /v2/accounts/{account-id}/applications/{application-id}Returns an account's local state and parameters for a given application.
GET /v2/accounts/{account-id}/assets/{asset-id}Returns an account's holding and parameters for a given asset.
GET /v2/accounts/{account-id}/transactions/pendingLists the pending transactions of an account, sorted by priority.
GET /v2/applications/{application-id}Returns an application, including its creator, programs, schemas and global state.
GET /v2/applications/{application-id}/{box-id}Returns an application box by name.
GET /v2/applications/{application-id}/boxesLists the box names of an application.
GET /v2/assets/{asset-id}Returns an asset, including its creator, name, total supply and special addresses.
GET /v2/blocks/{round}Returns the block at a given round.
GET /v2/blocks/{round}/hashReturns the hash of the block at a given round.
GET /v2/blocks/{round}/lightheader/proofReturns a proof of a light block header inside a state proof commitment.
GET /v2/blocks/{round}/transactions/{transaction-id}/proofReturns a proof that a transaction is included in the block at a given round.
GET /v2/blocks/{round}/txidsLists the top-level transaction IDs of the block at a given round.
GET /v2/deltas/{round}Returns the ledger state deltas for a given round.
GET /v2/ledger/supplyReturns the current supply of microAlgos.
GET /v2/statusReturns the current node status, including the last round.
GET /v2/status/wait-for-block-after/{round}Waits for a block after a given round, then returns the node status. Times out after one minute.
GET /v2/transactions/paramsReturns the suggested parameters for constructing a new transaction.
GET /v2/transactions/pendingLists the pending transactions in the pool, sorted by priority.
GET /v2/transactions/pending/{transaction-id}Returns information about a recently submitted transaction.
POST /v2/transactionsBroadcasts a signed transaction or transaction group to the network.
POST /v2/transactions/asyncBroadcasts a signed transaction or group, skipping most checks. Intended for development and testing.
POST /v2/transactions/simulateSimulates a transaction or transaction group against the latest committed round.

The gateway lists its supported endpoints at runtime:

Indexer

Base URLs

NetworkBase URL
Algorand Mainnethttps://algorand-mainnet-indexer.gateway.tatum.io
Algorand Testnethttps://algorand-testnet-indexer.gateway.tatum.io

Example request

curl 'https://algorand-mainnet-indexer.gateway.tatum.io/health' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

21 endpoints. Parameters and responses are described in the Algorand Indexer REST API reference; linked method names go to their page there.

EndpointDescription
GET /healthReturns the health status of the service.
GET /v2/accountsSearches for accounts matching the given filters.
GET /v2/accounts/{account-id}Returns account information, including balance and status.
GET /v2/accounts/{account-id}/apps-local-stateLists an account's application local states.
GET /v2/accounts/{account-id}/assetsLists an account's asset holdings.
GET /v2/accounts/{account-id}/created-applicationsLists the applications created by an account.
GET /v2/accounts/{account-id}/created-assetsLists the assets created by an account.
GET /v2/accounts/{account-id}/transactionsLists an account's transactions, newest first.
GET /v2/applicationsSearches for applications, optionally filtered by ID or creator.
GET /v2/applications/{application-id}Returns an application, including its creator, programs, schemas and global state.
GET /v2/applications/{application-id}/boxReturns an application box by name.
GET /v2/applications/{application-id}/boxesLists the box names of an application.
GET /v2/applications/{application-id}/logsLists the logs emitted by an application.
GET /v2/assetsSearches for assets matching the given filters.
GET /v2/assets/{asset-id}Returns an asset, including its creator, name, total supply and special addresses.
GET /v2/assets/{asset-id}/balancesLists the accounts that hold an asset.
GET /v2/assets/{asset-id}/transactionsLists the transactions of an asset, oldest first.
GET /v2/block-headersSearches for block headers, returned in ascending round order.
GET /v2/blocks/{round}Returns the block at a given round.
GET /v2/transactionsSearches for transactions matching the given filters.
GET /v2/transactions/{transaction-id}Returns a transaction by its ID.

The gateway lists its supported endpoints at runtime:

Endpoint unavailable?

If you need an endpoint we don't support yet, contact support.