MultiversX - REST API

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

NetworkBase URL
MultiversX Mainnethttps://multiversx-mainnet.gateway.tatum.io
MultiversX Devnethttps://multiversx-devnet.gateway.tatum.io
MultiversX Testnethttps://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.

EndpointDescription
GET /aboutReturns information about the API deployment.
GET /about/nodes-versionsReturns the software versions of the nodes behind the gateway.
GET /accountsLists accounts.
GET /accounts/{address}Returns the details of an account.
GET /accounts/{address}/collectionsLists 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/countReturns the number of collections in which an account holds tokens.
GET /accounts/{address}/contractsLists the smart contracts deployed by an account.
GET /accounts/{address}/contracts/countReturns the number of smart contracts deployed by an account.
GET /accounts/{address}/deferredReturns the deferred payments of an account from legacy staking.
GET /accounts/{address}/delegationReturns the delegation and undelegation positions of an account with staking providers.
GET /accounts/{address}/delegation-legacyReturns the legacy delegation pool position of an account.
GET /accounts/{address}/deploysLists the smart contract deployments of an account.
GET /accounts/{address}/deploys/countReturns the number of smart contract deployments of an account.
GET /accounts/{address}/esdthistoryReturns the ESDT balance history of an account.
GET /accounts/{address}/esdthistory/countReturns the number of ESDT balance history entries of an account.
GET /accounts/{address}/historyReturns 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}/countReturns the number of balance history entries of a token for an account.
GET /accounts/{address}/history/countReturns the number of EGLD balance history entries of an account.
GET /accounts/{address}/keysLists the active and queued validator nodes owned by an account.
GET /accounts/{address}/nftsLists 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/countReturns the number of NFTs, SFTs and MetaESDTs owned by an account.
GET /accounts/{address}/resultsLists 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/countReturns the number of smart contract results where an account is sender or receiver.
GET /accounts/{address}/roles/collectionsLists 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/countReturns the number of collections an account owns or holds special roles for.
GET /accounts/{address}/roles/tokensLists 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/countReturns the number of fungible tokens an account owns or holds special roles for.
GET /accounts/{address}/stakeReturns the staked amount and unbonding schedule of an account.
GET /accounts/{address}/tokensLists 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/countReturns the number of fungible tokens of an account.
GET /accounts/{address}/transactionsLists the transactions where an account is sender or receiver.
GET /accounts/{address}/transactions/countReturns the number of transactions where an account is sender or receiver.
GET /accounts/{address}/transfersLists the value transfers of an account, including smart contract results.
GET /accounts/{address}/transfers/countReturns the number of value transfers of an account.
GET /accounts/{address}/upgradesLists the upgrades of a smart contract.
GET /accounts/{address}/verificationReturns the source code verification details of a smart contract.
GET /accounts/{address}/waiting-listLists the queued validator nodes owned by an account.
GET /accounts/countReturns the total number of accounts.
GET /address/{address}Returns the account data of an address from the node.
GET /address/{address}/balanceReturns the EGLD balance of an address.
GET /address/{address}/esdtReturns all ESDT tokens held by an address.
GET /address/{address}/guardian-dataReturns 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}/keysReturns all key-value pairs in the storage of an address.
GET /address/{address}/nonceReturns the nonce of an address.
GET /address/{address}/shardReturns the shard of an address.
GET /applicationsLists smart contracts.
GET /applications/{address}Returns the details of a smart contract.
GET /applications/countReturns 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 /blocksLists blocks from all shards.
GET /blocks/{hash}Returns a block by hash.
GET /blocks/countReturns the number of blocks across all shards.
GET /blocks/latestReturns the latest block.
GET /collectionsLists NFT, SFT and MetaESDT collections.
GET /collections/{collection}Returns the details of a collection.
GET /collections/{collection}/nftsLists the tokens of a collection.
GET /collections/{collection}/nfts/countReturns the number of tokens in a collection.
GET /collections/{collection}/ranksReturns the NFT ranks of a collection that uses custom ranking.
GET /collections/{collection}/transactionsLists the transactions of a collection.
GET /collections/{collection}/transactions/countReturns the number of transactions of a collection.
GET /collections/{collection}/transfersLists the transfers of a collection.
GET /collections/{collection}/transfers/countReturns the number of transfers of a collection.
GET /collections/{identifier}/accountsLists the addresses that hold tokens of a collection, with balances.
GET /collections/countReturns the number of NFT, SFT and MetaESDT collections.
GET /constantsReturns network constants used to configure dApps.
GET /dapp/configReturns the configuration used by dApps.
GET /delegationReturns delegation staking statistics.
GET /delegation-legacyReturns statistics of the legacy delegation contract.
GET /economicsReturns network economics such as supply, staked amount and price.
GET /eventsLists smart contract events.
GET /events/{txHash}Returns an event by transaction hash.
GET /events/countReturns the number of smart contract events.
GET /helloReturns 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 /identitiesLists node identities, which group nodes run by the same entity.
GET /identities/{identifier}Returns the details of a node identity.
GET /identities/{identifier}/avatarReturns the avatar of a node identity.
GET /keys/{key}/unbond-periodReturns the remaining unbonding period of a BLS key.
GET /mex/economicsReturns xExchange economics.
GET /mex/farmsLists the farms on xExchange.
GET /mex/farms/countReturns the number of farms on xExchange.
GET /mex/pairsLists the active liquidity pools on xExchange.
GET /mex/pairs/{baseId}/{quoteId}Returns the xExchange liquidity pool of two tokens.
GET /mex/pairs/countReturns the number of active liquidity pools on xExchange.
GET /mex/tokensLists the tokens on xExchange.
GET /mex/tokens/{identifier}Returns the details of an xExchange token.
GET /mex/tokens/countReturns 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 /miniblocksLists miniblocks.
GET /miniblocks/{miniBlockHash}Returns a miniblock by hash.
GET /network/configReturns the network configuration parameters.
GET /network/economicsReturns the network economics metrics.
GET /network/gas-configsReturns 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 /nftsLists NFTs, SFTs and MetaESDTs.
GET /nfts/{identifier}Returns the details of an NFT, SFT or MetaESDT.
GET /nfts/{identifier}/accountsLists the addresses that hold an NFT, SFT or MetaESDT.
GET /nfts/{identifier}/accounts/countReturns the number of addresses that hold an NFT, SFT or MetaESDT.
GET /nfts/{identifier}/supplyReturns the supply of an NFT, SFT or MetaESDT.
GET /nfts/{identifier}/thumbnailReturns the thumbnail of an NFT.
GET /nfts/{identifier}/transactionsLists the transactions of an NFT or SFT.
GET /nfts/{identifier}/transactions/countReturns the number of transactions of an NFT or SFT.
GET /nfts/{identifier}/transfersLists the transfers of an NFT or SFT.
GET /nfts/{identifier}/transfers/countReturns the number of transfers of an NFT or SFT.
GET /nfts/countReturns the number of NFTs, SFTs and MetaESDTs.
GET /node/heartbeatstatusReturns 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 /nodesLists observer and validator nodes.
GET /nodes/{bls}Returns the details of a node by BLS key.
GET /nodes/countReturns the number of observer and validator nodes.
GET /nodes/versionsReturns the breakdown of validator node software versions.
GET /poolLists the transactions in the mempool.
GET /pool/{txhash}Returns a transaction from the mempool.
GET /pool/countReturns the number of transactions in the mempool.
GET /providersLists staking providers.
GET /providers/{address}Returns the details of a staking provider.
GET /providers/{address}/accountsLists the delegators of a staking provider.
GET /providers/{address}/accounts/countReturns the number of delegators of a staking provider.
GET /providers/{address}/avatarReturns the avatar of a staking provider.
GET /resultsLists smart contract results.
GET /results/{scHash}Returns a smart contract result by hash.
GET /results/countReturns the number of smart contract results.
GET /roundsLists rounds.
GET /rounds/{shard}/{round}Returns a round of a shard.
GET /rounds/countReturns the number of rounds.
GET /shardsLists the shards.
GET /stakeReturns general staking information.
GET /statsReturns general network statistics.
GET /tagsLists NFT tags.
GET /tags/{tag}Returns the details of an NFT tag.
GET /tags/countReturns the number of NFT tags.
GET /tokensLists fungible tokens.
GET /tokens/{identifier}Returns the details of a token.
GET /tokens/{identifier}/accountsLists the accounts that hold a token.
GET /tokens/{identifier}/accounts/countReturns the number of accounts that hold a token.
GET /tokens/{identifier}/logo/pngReturns the PNG logo of a token.
GET /tokens/{identifier}/logo/svgReturns the SVG logo of a token.
GET /tokens/{identifier}/supplyReturns the supply of a token.
GET /tokens/{identifier}/transactionsLists the transactions of a token.
GET /tokens/{identifier}/transactions/countReturns the number of transactions of a token.
GET /tokens/{identifier}/transfersLists the value transfers of a token, including smart contract results.
GET /tokens/{identifier}/transfers/countReturns the number of value transfers of a token.
GET /tokens/countReturns the number of fungible tokens.
GET /transaction/{txHash}Returns a transaction by hash from the node.
GET /transaction/{txHash}/process-statusReturns the processing status of a transaction.
GET /transaction/{txHash}/statusReturns the status of a transaction.
GET /transactionsLists transactions.
GET /transactions/{txHash}Returns a transaction by hash.
GET /transactions/countReturns the number of transactions.
GET /transactions/ppu/{shardId}Returns gas price per unit metadata for a shard.
GET /transfersLists value transfers, including smart contract results.
GET /transfers/countReturns the number of value transfers.
GET /usernames/USERNAMEReturns the account that owns a herotag (username).
GET /validator/statisticsReturns the rating and statistics of validators.
GET /waiting-listLists the nodes in the validator waiting list.
GET /waiting-list/countReturns the number of nodes in the validator waiting list.
GET /websocket/configReturns the WebSocket configuration of the API cluster.
POST /assetsSubmits token assets for review. Requires an access token.
POST /assets/authAuthenticates a request to submit assets.
POST /assets/convertConverts an uploaded asset file.
POST /batchSubmits a batch of signed transactions.
POST /contract-assetsSubmits smart contract assets for review. Requires an access token.
POST /nfts/processTriggers reprocessing of NFT media and metadata. Available to collection owners.
POST /queryRuns a read-only VM query on a smart contract.
POST /transaction/costEstimates the gas cost of a transaction.
POST /transaction/sendBroadcasts a signed transaction.
POST /transaction/send-multipleBroadcasts multiple signed transactions.
POST /transaction/send-user-fundsRequests funds from the gateway faucet, where enabled.
POST /transaction/simulateSimulates a signed transaction without broadcasting it.
POST /transactionsBroadcasts a signed transaction.
POST /transactions/decodeDecodes 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.