REST API endpoints supported on MultiversX Mainnet, MultiversX Devnet and MultiversX Testnet through Tatum RPC Gateway, with base URLs and an example request.
Call MultiversX 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.
Base URLs
| Network | Base URL |
|---|---|
| MultiversX Mainnet | https://multiversx-mainnet.gateway.tatum.io |
| MultiversX Devnet | https://multiversx-devnet.gateway.tatum.io |
| MultiversX Testnet | https://multiversx-testnet.gateway.tatum.io |
Example request
curl 'https://multiversx-mainnet.gateway.tatum.io/network/config' \
--header 'x-api-key: {YOUR_API_KEY}'Endpoints
184 endpoints. Parameters and responses are described in the MultiversX REST API documentation.
| Endpoint | Description |
|---|---|
GET /about | Returns information about the API deployment. |
GET /about/nodes-versions | Returns the software versions of the nodes behind the gateway. |
GET /accounts | Lists accounts. |
GET /accounts/{address} | Returns the details of an account. |
GET /accounts/{address}/collections | Lists the NFT, SFT and MetaESDT collections in which an account holds tokens. |
GET /accounts/{address}/collections/{collection} | Returns the details of a collection held by an account. |
GET /accounts/{address}/collections/count | Returns the number of collections in which an account holds tokens. |
GET /accounts/{address}/contracts | Lists the smart contracts deployed by an account. |
GET /accounts/{address}/contracts/count | Returns the number of smart contracts deployed by an account. |
GET /accounts/{address}/deferred | Returns the deferred payments of an account from legacy staking. |
GET /accounts/{address}/delegation | Returns the delegation and undelegation positions of an account with staking providers. |
GET /accounts/{address}/delegation-legacy | Returns the legacy delegation pool position of an account. |
GET /accounts/{address}/deploys | Lists the smart contract deployments of an account. |
GET /accounts/{address}/deploys/count | Returns the number of smart contract deployments of an account. |
GET /accounts/{address}/esdthistory | Returns the ESDT balance history of an account. |
GET /accounts/{address}/esdthistory/count | Returns the number of ESDT balance history entries of an account. |
GET /accounts/{address}/history | Returns the EGLD balance history of an account. |
GET /accounts/{address}/history/{tokenIdentifier} | Returns the balance history of a token for an account. |
GET /accounts/{address}/history/{tokenIdentifier}/count | Returns the number of balance history entries of a token for an account. |
GET /accounts/{address}/history/count | Returns the number of EGLD balance history entries of an account. |
GET /accounts/{address}/keys | Lists the active and queued validator nodes owned by an account. |
GET /accounts/{address}/nfts | Lists the NFTs, SFTs and MetaESDTs owned by an account. |
GET /accounts/{address}/nfts/{nft} | Returns the details of an NFT, SFT or MetaESDT owned by an account. |
GET /accounts/{address}/nfts/count | Returns the number of NFTs, SFTs and MetaESDTs owned by an account. |
GET /accounts/{address}/results | Lists the smart contract results where an account is sender or receiver. |
GET /accounts/{address}/results/{scHash} | Returns a smart contract result where an account is sender or receiver. |
GET /accounts/{address}/results/count | Returns the number of smart contract results where an account is sender or receiver. |
GET /accounts/{address}/roles/collections | Lists the collections an account owns or holds special roles for. |
GET /accounts/{address}/roles/collections/{collection} | Returns the roles of an account for a collection. |
GET /accounts/{address}/roles/collections/count | Returns the number of collections an account owns or holds special roles for. |
GET /accounts/{address}/roles/tokens | Lists the fungible tokens an account owns or holds special roles for. |
GET /accounts/{address}/roles/tokens/{identifier} | Returns the roles of an account for a fungible token. |
GET /accounts/{address}/roles/tokens/count | Returns the number of fungible tokens an account owns or holds special roles for. |
GET /accounts/{address}/stake | Returns the staked amount and unbonding schedule of an account. |
GET /accounts/{address}/tokens | Lists the fungible tokens of an account with their balances. |
GET /accounts/{address}/tokens/{token} | Returns the balance and details of a fungible token for an account. |
GET /accounts/{address}/tokens/count | Returns the number of fungible tokens of an account. |
GET /accounts/{address}/transactions | Lists the transactions where an account is sender or receiver. |
GET /accounts/{address}/transactions/count | Returns the number of transactions where an account is sender or receiver. |
GET /accounts/{address}/transfers | Lists the value transfers of an account, including smart contract results. |
GET /accounts/{address}/transfers/count | Returns the number of value transfers of an account. |
GET /accounts/{address}/upgrades | Lists the upgrades of a smart contract. |
GET /accounts/{address}/verification | Returns the source code verification details of a smart contract. |
GET /accounts/{address}/waiting-list | Lists the queued validator nodes owned by an account. |
GET /accounts/count | Returns the total number of accounts. |
GET /address/{address} | Returns the account data of an address from the node. |
GET /address/{address}/balance | Returns the EGLD balance of an address. |
GET /address/{address}/esdt | Returns all ESDT tokens held by an address. |
GET /address/{address}/guardian-data | Returns the guardian data of an address. |
GET /address/{address}/key/{key} | Returns the value stored under a key in the storage of an address. |
GET /address/{address}/keys | Returns all key-value pairs in the storage of an address. |
GET /address/{address}/nonce | Returns the nonce of an address. |
GET /address/{address}/shard | Returns the shard of an address. |
GET /applications | Lists smart contracts. |
GET /applications/{address} | Returns the details of a smart contract. |
GET /applications/count | Returns the total number of smart contracts. |
GET /batch/{address} | Lists the transaction batches submitted by an address. |
GET /batch/{address}/{id} | Returns a transaction batch by ID. |
GET /block/{shard}/by-hash/{hash} | Returns a block of a shard by hash. |
GET /block/{shard}/by-nonce/{nonce} | Returns a block of a shard by nonce. |
GET /blocks | Lists blocks from all shards. |
GET /blocks/{hash} | Returns a block by hash. |
GET /blocks/count | Returns the number of blocks across all shards. |
GET /blocks/latest | Returns the latest block. |
GET /collections | Lists NFT, SFT and MetaESDT collections. |
GET /collections/{collection} | Returns the details of a collection. |
GET /collections/{collection}/nfts | Lists the tokens of a collection. |
GET /collections/{collection}/nfts/count | Returns the number of tokens in a collection. |
GET /collections/{collection}/ranks | Returns the NFT ranks of a collection that uses custom ranking. |
GET /collections/{collection}/transactions | Lists the transactions of a collection. |
GET /collections/{collection}/transactions/count | Returns the number of transactions of a collection. |
GET /collections/{collection}/transfers | Lists the transfers of a collection. |
GET /collections/{collection}/transfers/count | Returns the number of transfers of a collection. |
GET /collections/{identifier}/accounts | Lists the addresses that hold tokens of a collection, with balances. |
GET /collections/count | Returns the number of NFT, SFT and MetaESDT collections. |
GET /constants | Returns network constants used to configure dApps. |
GET /dapp/config | Returns the configuration used by dApps. |
GET /delegation | Returns delegation staking statistics. |
GET /delegation-legacy | Returns statistics of the legacy delegation contract. |
GET /economics | Returns network economics such as supply, staked amount and price. |
GET /events | Lists smart contract events. |
GET /events/{txHash} | Returns an event by transaction hash. |
GET /events/count | Returns the number of smart contract events. |
GET /hello | Returns hello. Used as a health check. |
GET /hyperblock/by-hash/{hash} | Returns a hyperblock (metachain block with all notarized shard blocks) by hash. |
GET /hyperblock/by-nonce/{nonce} | Returns a hyperblock (metachain block with all notarized shard blocks) by nonce. |
GET /identities | Lists node identities, which group nodes run by the same entity. |
GET /identities/{identifier} | Returns the details of a node identity. |
GET /identities/{identifier}/avatar | Returns the avatar of a node identity. |
GET /keys/{key}/unbond-period | Returns the remaining unbonding period of a BLS key. |
GET /mex/economics | Returns xExchange economics. |
GET /mex/farms | Lists the farms on xExchange. |
GET /mex/farms/count | Returns the number of farms on xExchange. |
GET /mex/pairs | Lists the active liquidity pools on xExchange. |
GET /mex/pairs/{baseId}/{quoteId} | Returns the xExchange liquidity pool of two tokens. |
GET /mex/pairs/count | Returns the number of active liquidity pools on xExchange. |
GET /mex/tokens | Lists the tokens on xExchange. |
GET /mex/tokens/{identifier} | Returns the details of an xExchange token. |
GET /mex/tokens/count | Returns the number of tokens on xExchange. |
GET /mex/tokens/prices/daily/{identifier} | Returns the daily prices of an xExchange token. |
GET /mex/tokens/prices/hourly/{identifier} | Returns the hourly prices of an xExchange token. |
GET /miniblocks | Lists miniblocks. |
GET /miniblocks/{miniBlockHash} | Returns a miniblock by hash. |
GET /network/config | Returns the network configuration parameters. |
GET /network/economics | Returns the network economics metrics. |
GET /network/gas-configs | Returns the gas cost configuration of the network. |
GET /network/status/{shard} | Returns the status metrics of a shard, such as current round and nonce. |
GET /nfts | Lists NFTs, SFTs and MetaESDTs. |
GET /nfts/{identifier} | Returns the details of an NFT, SFT or MetaESDT. |
GET /nfts/{identifier}/accounts | Lists the addresses that hold an NFT, SFT or MetaESDT. |
GET /nfts/{identifier}/accounts/count | Returns the number of addresses that hold an NFT, SFT or MetaESDT. |
GET /nfts/{identifier}/supply | Returns the supply of an NFT, SFT or MetaESDT. |
GET /nfts/{identifier}/thumbnail | Returns the thumbnail of an NFT. |
GET /nfts/{identifier}/transactions | Lists the transactions of an NFT or SFT. |
GET /nfts/{identifier}/transactions/count | Returns the number of transactions of an NFT or SFT. |
GET /nfts/{identifier}/transfers | Lists the transfers of an NFT or SFT. |
GET /nfts/{identifier}/transfers/count | Returns the number of transfers of an NFT or SFT. |
GET /nfts/count | Returns the number of NFTs, SFTs and MetaESDTs. |
GET /node/heartbeatstatus | Returns the heartbeat status of the network nodes. |
GET /node/waiting-epochs-left/{key} | Returns the number of epochs left in the waiting list for a BLS key. |
GET /nodes | Lists observer and validator nodes. |
GET /nodes/{bls} | Returns the details of a node by BLS key. |
GET /nodes/count | Returns the number of observer and validator nodes. |
GET /nodes/versions | Returns the breakdown of validator node software versions. |
GET /pool | Lists the transactions in the mempool. |
GET /pool/{txhash} | Returns a transaction from the mempool. |
GET /pool/count | Returns the number of transactions in the mempool. |
GET /providers | Lists staking providers. |
GET /providers/{address} | Returns the details of a staking provider. |
GET /providers/{address}/accounts | Lists the delegators of a staking provider. |
GET /providers/{address}/accounts/count | Returns the number of delegators of a staking provider. |
GET /providers/{address}/avatar | Returns the avatar of a staking provider. |
GET /results | Lists smart contract results. |
GET /results/{scHash} | Returns a smart contract result by hash. |
GET /results/count | Returns the number of smart contract results. |
GET /rounds | Lists rounds. |
GET /rounds/{shard}/{round} | Returns a round of a shard. |
GET /rounds/count | Returns the number of rounds. |
GET /shards | Lists the shards. |
GET /stake | Returns general staking information. |
GET /stats | Returns general network statistics. |
GET /tags | Lists NFT tags. |
GET /tags/{tag} | Returns the details of an NFT tag. |
GET /tags/count | Returns the number of NFT tags. |
GET /tokens | Lists fungible tokens. |
GET /tokens/{identifier} | Returns the details of a token. |
GET /tokens/{identifier}/accounts | Lists the accounts that hold a token. |
GET /tokens/{identifier}/accounts/count | Returns the number of accounts that hold a token. |
GET /tokens/{identifier}/logo/png | Returns the PNG logo of a token. |
GET /tokens/{identifier}/logo/svg | Returns the SVG logo of a token. |
GET /tokens/{identifier}/supply | Returns the supply of a token. |
GET /tokens/{identifier}/transactions | Lists the transactions of a token. |
GET /tokens/{identifier}/transactions/count | Returns the number of transactions of a token. |
GET /tokens/{identifier}/transfers | Lists the value transfers of a token, including smart contract results. |
GET /tokens/{identifier}/transfers/count | Returns the number of value transfers of a token. |
GET /tokens/count | Returns the number of fungible tokens. |
GET /transaction/{txHash} | Returns a transaction by hash from the node. |
GET /transaction/{txHash}/process-status | Returns the processing status of a transaction. |
GET /transaction/{txHash}/status | Returns the status of a transaction. |
GET /transactions | Lists transactions. |
GET /transactions/{txHash} | Returns a transaction by hash. |
GET /transactions/count | Returns the number of transactions. |
GET /transactions/ppu/{shardId} | Returns gas price per unit metadata for a shard. |
GET /transfers | Lists value transfers, including smart contract results. |
GET /transfers/count | Returns the number of value transfers. |
GET /usernames/USERNAME | Returns the account that owns a herotag (username). |
GET /validator/statistics | Returns the rating and statistics of validators. |
GET /waiting-list | Lists the nodes in the validator waiting list. |
GET /waiting-list/count | Returns the number of nodes in the validator waiting list. |
GET /websocket/config | Returns the WebSocket configuration of the API cluster. |
POST /assets | Submits token assets for review. Requires an access token. |
POST /assets/auth | Authenticates a request to submit assets. |
POST /assets/convert | Converts an uploaded asset file. |
POST /batch | Submits a batch of signed transactions. |
POST /contract-assets | Submits smart contract assets for review. Requires an access token. |
POST /nfts/process | Triggers reprocessing of NFT media and metadata. Available to collection owners. |
POST /query | Runs a read-only VM query on a smart contract. |
POST /transaction/cost | Estimates the gas cost of a transaction. |
POST /transaction/send | Broadcasts a signed transaction. |
POST /transaction/send-multiple | Broadcasts multiple signed transactions. |
POST /transaction/send-user-funds | Requests funds from the gateway faucet, where enabled. |
POST /transaction/simulate | Simulates a signed transaction without broadcasting it. |
POST /transactions | Broadcasts a signed transaction. |
POST /transactions/decode | Decodes the action of a transaction. |
The gateway lists its supported endpoints at runtime:
Endpoint unavailable?If you need an endpoint we don't support yet, contact support.