Tron - REST API

REST API endpoints supported on Tron Mainnet, Tron Nile and Tron Shasta through Tatum RPC Gateway, with base URLs and an example request.

Call Tron 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.

Tron has 2 REST API interfaces, each with its own base URLs and endpoints: HTTP API and Solidity HTTP API.

HTTP API

Base URLs

NetworkBase URL
Tron Mainnethttps://tron-mainnet.gateway.tatum.io/wallet
Tron Nilehttps://tron-nile.gateway.tatum.io/wallet
Tron Shastahttps://tron-shasta.gateway.tatum.io/wallet

Example request

curl 'https://tron-mainnet.gateway.tatum.io/wallet/getnowblock' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

222 endpoints. Parameters and responses are described in the TRON FullNode HTTP API reference.

EndpointDescription
GET /accountpermissionupdateBuilds a transaction that updates the permissions of an account.
GET /broadcasthexBroadcasts a signed transaction encoded as a protobuf hex string.
GET /broadcasttransactionBroadcasts a signed transaction in JSON format.
GET /cancelallunfreezev2Builds a transaction that cancels all pending Stake 2.0 unstaking requests of an account.
GET /clearabiBuilds a transaction that clears the ABI of a smart contract.
GET /createaccountBuilds a transaction that activates a new account.
GET /createassetissueBuilds a transaction that issues a TRC10 token.
GET /createshieldedcontractparametersCreates the parameters for a shielded TRC20 contract transaction.
GET /createshieldedcontractparameterswithoutaskCreates the parameters for a shielded TRC20 contract transaction without the spending key ask.
GET /createspendauthsigCreates a spend authorization signature for a shielded transaction.
GET /createtransactionBuilds a transaction that transfers TRX.
GET /createwitnessBuilds a transaction that applies to become a super representative candidate.
GET /delegateresourceBuilds a transaction that delegates bandwidth or energy to another account (Stake 2.0).
GET /deploycontractBuilds a transaction that deploys a smart contract.
GET /estimateenergyEstimates the energy needed to execute a smart contract call.
GET /exchangecreateBuilds a transaction that creates an exchange pair.
GET /exchangeinjectBuilds a transaction that injects tokens into an exchange pair.
GET /exchangetransactionBuilds a transaction that trades tokens on an exchange pair.
GET /exchangewithdrawBuilds a transaction that withdraws tokens from an exchange pair.
GET /freezebalancev2Builds a transaction that stakes TRX for bandwidth or energy (Stake 2.0).
GET /getaccountReturns account details, including balances, resources, votes and permissions.
GET /getaccountbalanceReturns the balance of an account at a given block.
GET /getaccountbyidReturns account details by account ID.
GET /getaccountnetReturns the bandwidth information of an account.
GET /getaccountresourceReturns the bandwidth and energy resources of an account.
GET /getapprovedlistReturns the addresses that have signed a transaction.
GET /getassetissuebyaccountReturns the TRC10 tokens issued by an account.
GET /getassetissuebyidReturns a TRC10 token by ID.
GET /getassetissuebynameReturns a TRC10 token by name.
GET /getassetissuelistLists all TRC10 tokens.
GET /getassetissuelistbynameLists all TRC10 tokens with a given name.
GET /getavailableunfreezecountReturns how many more Stake 2.0 unstake operations an account can perform.
GET /getbandwidthpricesReturns the history of bandwidth unit prices.
GET /getblockReturns a block header or full block by height or hash.
GET /getblockbalanceReturns all balance changes in a block.
GET /getblockbyidReturns a block by hash.
GET /getblockbylatestnumReturns the latest blocks, up to a given number.
GET /getblockbylimitnextReturns the blocks in a height range.
GET /getblockbynumReturns a block by height.
GET /getBrokerageReturns the brokerage ratio of a super representative.
GET /getburntrxReturns the total amount of TRX burned for transaction fees.
GET /getcandelegatedmaxsizeReturns the maximum amount of a resource an account can delegate (Stake 2.0).
GET /getcanwithdrawunfreezeamountReturns the unstaked TRX an account can withdraw at a given time (Stake 2.0).
GET /getchainparametersReturns the network parameters that committee proposals can change.
GET /getcontractReturns the bytecode, ABI and settings of a smart contract.
GET /getcontractinfoReturns the details of a smart contract, including its runtime code and state.
GET /getdelegatedresourceReturns the resources one account delegated to another (Stake 1.0).
GET /getdelegatedresourceaccountindexReturns the resource delegation index of an account (Stake 1.0).
GET /getdelegatedresourceaccountindexv2Returns the resource delegation index of an account (Stake 2.0).
GET /getdelegatedresourcev2Returns the resources one account delegated to another (Stake 2.0).
GET /getdiversifierGenerates a diversifier for a shielded address.
GET /getenergypricesReturns the history of energy unit prices.
GET /getexchangebyidReturns an exchange pair by ID.
GET /getincomingviewingkeyDerives the incoming viewing key ivk from ak and nk.
GET /getmarketorderbyaccountReturns the market orders of an account.
GET /getmarketorderbyidReturns a market order by ID.
GET /getmarketorderlistbypairReturns the market orders of a trading pair.
GET /getmarketpairlistLists all market trading pairs.
GET /getmarketpricebypairReturns the prices of a market trading pair.
GET /getnewshieldedaddressGenerates a new shielded address and its keys.
GET /getnextmaintenancetimeReturns the timestamp of the next maintenance period, when votes are counted.
GET /getnkfromnskDerives nk from nsk for a shielded address.
GET /getnodeinfoReturns information about the node.
GET /getnowblockReturns the latest block.
GET /getpaginatedassetissuelistLists TRC10 tokens with pagination.
GET /getpaginatedexchangelistLists exchange pairs with pagination.
GET /getpaginatedproposallistLists proposals with pagination.
GET /getpendingsizeReturns the number of transactions in the pending pool.
GET /getproposalbyidReturns a proposal by ID.
GET /getrcmGenerates a random commitment trapdoor rcm for a shielded transaction.
GET /getRewardReturns the unclaimed voting rewards of an account.
GET /getsignweightReturns the current signature weight of a multi-signature transaction.
GET /gettransactionbyidReturns a transaction by ID.
GET /gettransactioncountbyblocknumReturns the number of transactions in a block.
GET /gettransactionfrompendingReturns a transaction from the pending pool.
GET /gettransactioninfobyblocknumReturns the receipts of all transactions in a block, including fees and logs.
GET /gettransactioninfobyidReturns the receipt of a transaction, including fee, block height and logs.
GET /gettransactionlistfrompendingLists the IDs of transactions in the pending pool.
GET /gettriggerinputforshieldedtrc20contractReturns the trigger input for a shielded TRC20 contract transfer.
GET /getzenpaymentaddressReturns a shielded payment address from an incoming viewing key and diversifier.
GET /isshieldedtrc20contractnotespentChecks whether a shielded TRC20 note has been spent.
GET /listexchangesLists all exchange pairs.
GET /listnodesLists the nodes connected to the API node.
GET /listproposalsLists all proposals.
GET /listwitnessesLists all super representatives.
GET /marketcancelorderBuilds a transaction that cancels a market order.
GET /marketsellassetBuilds a transaction that creates a market order to sell a token.
GET /participateassetissueBuilds a transaction that buys a TRC10 token during its issuance.
GET /proposalapproveBuilds a transaction that approves a proposal.
GET /proposalcreateBuilds a transaction that creates a proposal.
GET /proposaldeleteBuilds a transaction that deletes a proposal.
GET /scanshieldedtrc20notesbyivkScans shielded TRC20 notes received, using an incoming viewing key.
GET /scanshieldedtrc20notesbyovkScans shielded TRC20 notes sent, using an outgoing viewing key.
GET /setaccountidBuilds a transaction that sets the ID of an account.
GET /transferassetBuilds a transaction that transfers a TRC10 token.
GET /triggerconstantcontractCalls a read-only smart contract function, or simulates a call without broadcasting it.
GET /triggersmartcontractBuilds a transaction that calls a smart contract function.
GET /undelegateresourceBuilds a transaction that cancels a resource delegation (Stake 2.0).
GET /unfreezeassetBuilds a transaction that unstakes TRC10 tokens whose freeze period has ended.
GET /unfreezebalanceBuilds a transaction that unstakes TRX staked in Stake 1.0.
GET /unfreezebalancev2Builds a transaction that unstakes TRX staked in Stake 2.0.
GET /updateaccountBuilds a transaction that updates the name of an account.
GET /updateassetBuilds a transaction that updates the details of a TRC10 token.
GET /updateBrokerageBuilds a transaction that updates the brokerage ratio of a super representative.
GET /updateenergylimitBuilds a transaction that updates the origin_energy_limit of a smart contract.
GET /updatesettingBuilds a transaction that updates the consume_user_resource_percent of a smart contract.
GET /updatewitnessBuilds a transaction that updates the website URL of a super representative.
GET /validateaddressChecks whether an address is valid.
GET /votewitnessaccountBuilds a transaction that votes for super representatives.
GET /withdrawbalanceBuilds a transaction that withdraws the rewards of an account. Allowed once every 24 hours.
GET /withdrawexpireunfreezeBuilds a transaction that withdraws TRX whose Stake 2.0 unstaking period has ended.
POST /accountpermissionupdateBuilds a transaction that updates the permissions of an account.
POST /broadcasthexBroadcasts a signed transaction encoded as a protobuf hex string.
POST /broadcasttransactionBroadcasts a signed transaction in JSON format.
POST /cancelallunfreezev2Builds a transaction that cancels all pending Stake 2.0 unstaking requests of an account.
POST /clearabiBuilds a transaction that clears the ABI of a smart contract.
POST /createaccountBuilds a transaction that activates a new account.
POST /createassetissueBuilds a transaction that issues a TRC10 token.
POST /createshieldedcontractparametersCreates the parameters for a shielded TRC20 contract transaction.
POST /createshieldedcontractparameterswithoutaskCreates the parameters for a shielded TRC20 contract transaction without the spending key ask.
POST /createspendauthsigCreates a spend authorization signature for a shielded transaction.
POST /createtransactionBuilds a transaction that transfers TRX.
POST /createwitnessBuilds a transaction that applies to become a super representative candidate.
POST /delegateresourceBuilds a transaction that delegates bandwidth or energy to another account (Stake 2.0).
POST /deploycontractBuilds a transaction that deploys a smart contract.
POST /estimateenergyEstimates the energy needed to execute a smart contract call.
POST /exchangecreateBuilds a transaction that creates an exchange pair.
POST /exchangeinjectBuilds a transaction that injects tokens into an exchange pair.
POST /exchangetransactionBuilds a transaction that trades tokens on an exchange pair.
POST /exchangewithdrawBuilds a transaction that withdraws tokens from an exchange pair.
POST /freezebalancev2Builds a transaction that stakes TRX for bandwidth or energy (Stake 2.0).
POST /getaccountReturns account details, including balances, resources, votes and permissions.
POST /getaccountbalanceReturns the balance of an account at a given block.
POST /getaccountbyidReturns account details by account ID.
POST /getaccountnetReturns the bandwidth information of an account.
POST /getaccountresourceReturns the bandwidth and energy resources of an account.
POST /getapprovedlistReturns the addresses that have signed a transaction.
POST /getassetissuebyaccountReturns the TRC10 tokens issued by an account.
POST /getassetissuebyidReturns a TRC10 token by ID.
POST /getassetissuebynameReturns a TRC10 token by name.
POST /getassetissuelistLists all TRC10 tokens.
POST /getassetissuelistbynameLists all TRC10 tokens with a given name.
POST /getavailableunfreezecountReturns how many more Stake 2.0 unstake operations an account can perform.
POST /getbandwidthpricesReturns the history of bandwidth unit prices.
POST /getblockReturns a block header or full block by height or hash.
POST /getblockbalanceReturns all balance changes in a block.
POST /getblockbyidReturns a block by hash.
POST /getblockbylatestnumReturns the latest blocks, up to a given number.
POST /getblockbylimitnextReturns the blocks in a height range.
POST /getblockbynumReturns a block by height.
POST /getBrokerageReturns the brokerage ratio of a super representative.
POST /getburntrxReturns the total amount of TRX burned for transaction fees.
POST /getcandelegatedmaxsizeReturns the maximum amount of a resource an account can delegate (Stake 2.0).
POST /getcanwithdrawunfreezeamountReturns the unstaked TRX an account can withdraw at a given time (Stake 2.0).
POST /getchainparametersReturns the network parameters that committee proposals can change.
POST /getcontractReturns the bytecode, ABI and settings of a smart contract.
POST /getcontractinfoReturns the details of a smart contract, including its runtime code and state.
POST /getdelegatedresourceReturns the resources one account delegated to another (Stake 1.0).
POST /getdelegatedresourceaccountindexReturns the resource delegation index of an account (Stake 1.0).
POST /getdelegatedresourceaccountindexv2Returns the resource delegation index of an account (Stake 2.0).
POST /getdelegatedresourcev2Returns the resources one account delegated to another (Stake 2.0).
POST /getdiversifierGenerates a diversifier for a shielded address.
POST /getenergypricesReturns the history of energy unit prices.
POST /getexchangebyidReturns an exchange pair by ID.
POST /getincomingviewingkeyDerives the incoming viewing key ivk from ak and nk.
POST /getmarketorderbyaccountReturns the market orders of an account.
POST /getmarketorderbyidReturns a market order by ID.
POST /getmarketorderlistbypairReturns the market orders of a trading pair.
POST /getmarketpairlistLists all market trading pairs.
POST /getmarketpricebypairReturns the prices of a market trading pair.
POST /getnewshieldedaddressGenerates a new shielded address and its keys.
POST /getnextmaintenancetimeReturns the timestamp of the next maintenance period, when votes are counted.
POST /getnkfromnskDerives nk from nsk for a shielded address.
POST /getnodeinfoReturns information about the node.
POST /getnowblockReturns the latest block.
POST /getpaginatedassetissuelistLists TRC10 tokens with pagination.
POST /getpaginatedexchangelistLists exchange pairs with pagination.
POST /getpaginatedproposallistLists proposals with pagination.
POST /getpendingsizeReturns the number of transactions in the pending pool.
POST /getproposalbyidReturns a proposal by ID.
POST /getrcmGenerates a random commitment trapdoor rcm for a shielded transaction.
POST /getRewardReturns the unclaimed voting rewards of an account.
POST /getsignweightReturns the current signature weight of a multi-signature transaction.
POST /gettransactionbyidReturns a transaction by ID.
POST /gettransactioncountbyblocknumReturns the number of transactions in a block.
POST /gettransactionfrompendingReturns a transaction from the pending pool.
POST /gettransactioninfobyblocknumReturns the receipts of all transactions in a block, including fees and logs.
POST /gettransactioninfobyidReturns the receipt of a transaction, including fee, block height and logs.
POST /gettransactionlistfrompendingLists the IDs of transactions in the pending pool.
POST /gettriggerinputforshieldedtrc20contractReturns the trigger input for a shielded TRC20 contract transfer.
POST /getzenpaymentaddressReturns a shielded payment address from an incoming viewing key and diversifier.
POST /isshieldedtrc20contractnotespentChecks whether a shielded TRC20 note has been spent.
POST /listexchangesLists all exchange pairs.
POST /listnodesLists the nodes connected to the API node.
POST /listproposalsLists all proposals.
POST /listwitnessesLists all super representatives.
POST /marketcancelorderBuilds a transaction that cancels a market order.
POST /marketsellassetBuilds a transaction that creates a market order to sell a token.
POST /participateassetissueBuilds a transaction that buys a TRC10 token during its issuance.
POST /proposalapproveBuilds a transaction that approves a proposal.
POST /proposalcreateBuilds a transaction that creates a proposal.
POST /proposaldeleteBuilds a transaction that deletes a proposal.
POST /scanshieldedtrc20notesbyivkScans shielded TRC20 notes received, using an incoming viewing key.
POST /scanshieldedtrc20notesbyovkScans shielded TRC20 notes sent, using an outgoing viewing key.
POST /setaccountidBuilds a transaction that sets the ID of an account.
POST /transferassetBuilds a transaction that transfers a TRC10 token.
POST /triggerconstantcontractCalls a read-only smart contract function, or simulates a call without broadcasting it.
POST /triggersmartcontractBuilds a transaction that calls a smart contract function.
POST /undelegateresourceBuilds a transaction that cancels a resource delegation (Stake 2.0).
POST /unfreezeassetBuilds a transaction that unstakes TRC10 tokens whose freeze period has ended.
POST /unfreezebalanceBuilds a transaction that unstakes TRX staked in Stake 1.0.
POST /unfreezebalancev2Builds a transaction that unstakes TRX staked in Stake 2.0.
POST /updateaccountBuilds a transaction that updates the name of an account.
POST /updateassetBuilds a transaction that updates the details of a TRC10 token.
POST /updateBrokerageBuilds a transaction that updates the brokerage ratio of a super representative.
POST /updateenergylimitBuilds a transaction that updates the origin_energy_limit of a smart contract.
POST /updatesettingBuilds a transaction that updates the consume_user_resource_percent of a smart contract.
POST /updatewitnessBuilds a transaction that updates the website URL of a super representative.
POST /validateaddressChecks whether an address is valid.
POST /votewitnessaccountBuilds a transaction that votes for super representatives.
POST /withdrawbalanceBuilds a transaction that withdraws the rewards of an account. Allowed once every 24 hours.
POST /withdrawexpireunfreezeBuilds a transaction that withdraws TRX whose Stake 2.0 unstaking period has ended.

The gateway lists its supported endpoints at runtime:

Solidity HTTP API

Base URLs

NetworkBase URL
Tron Mainnethttps://tron-mainnet.gateway.tatum.io/walletsolidity
Tron Nilehttps://tron-nile.gateway.tatum.io/walletsolidity
Tron Shastahttps://tron-shasta.gateway.tatum.io/walletsolidity

Example request

curl 'https://tron-mainnet.gateway.tatum.io/walletsolidity/getnowblock' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

86 endpoints. Parameters and responses are described in the TRON Solidity HTTP API reference.

EndpointDescription
GET /estimateenergyEstimates the energy needed to execute a smart contract call.
GET /getaccountReturns account details, including balances, resources, votes and permissions.
GET /getaccountbyidReturns account details by account ID.
GET /getassetissuebyidReturns a TRC10 token by ID.
GET /getassetissuebynameReturns a TRC10 token by name.
GET /getassetissuelistLists all TRC10 tokens.
GET /getassetissuelistbynameLists all TRC10 tokens with a given name.
GET /getavailableunfreezecountReturns how many more Stake 2.0 unstake operations an account can perform.
GET /getbandwidthpricesReturns the history of bandwidth unit prices.
GET /getblockReturns a block header or full block by height or hash.
GET /getblockbyidReturns a block by hash.
GET /getblockbylatestnumReturns the latest blocks, up to a given number.
GET /getblockbylimitnextReturns the blocks in a height range.
GET /getblockbynumReturns a block by height.
GET /getBrokerageReturns the brokerage ratio of a super representative.
GET /getburntrxReturns the total amount of TRX burned for transaction fees.
GET /getcandelegatedmaxsizeReturns the maximum amount of a resource an account can delegate (Stake 2.0).
GET /getcanwithdrawunfreezeamountReturns the unstaked TRX an account can withdraw at a given time (Stake 2.0).
GET /getdelegatedresourceReturns the resources one account delegated to another (Stake 1.0).
GET /getdelegatedresourceaccountindexReturns the resource delegation index of an account (Stake 1.0).
GET /getdelegatedresourceaccountindexv2Returns the resource delegation index of an account (Stake 2.0).
GET /getdelegatedresourcev2Returns the resources one account delegated to another (Stake 2.0).
GET /getenergypricesReturns the history of energy unit prices.
GET /getexchangebyidReturns an exchange pair by ID.
GET /getmarketorderbyaccountReturns the market orders of an account.
GET /getmarketorderbyidReturns a market order by ID.
GET /getmarketorderlistbypairReturns the market orders of a trading pair.
GET /getmarketpairlistLists all market trading pairs.
GET /getmarketpricebypairReturns the prices of a market trading pair.
GET /getnodeinfoReturns information about the node.
GET /getnowblockReturns the latest block.
GET /getpaginatedassetissuelistLists TRC10 tokens with pagination.
GET /getRewardReturns the unclaimed voting rewards of an account.
GET /gettransactionbyidReturns a transaction by ID.
GET /gettransactioncountbyblocknumReturns the number of transactions in a block.
GET /gettransactioninfobyblocknumReturns the receipts of all transactions in a block, including fees and logs.
GET /gettransactioninfobyidReturns the receipt of a transaction, including fee, block height and logs.
GET /isshieldedtrc20contractnotespentChecks whether a shielded TRC20 note has been spent.
GET /listexchangesLists all exchange pairs.
GET /listwitnessesLists all super representatives.
GET /scanshieldedtrc20notesbyivkScans shielded TRC20 notes received, using an incoming viewing key.
GET /scanshieldedtrc20notesbyovkScans shielded TRC20 notes sent, using an outgoing viewing key.
GET /triggerconstantcontractCalls a read-only smart contract function, or simulates a call without broadcasting it.
POST /estimateenergyEstimates the energy needed to execute a smart contract call.
POST /getaccountReturns account details, including balances, resources, votes and permissions.
POST /getaccountbyidReturns account details by account ID.
POST /getassetissuebyidReturns a TRC10 token by ID.
POST /getassetissuebynameReturns a TRC10 token by name.
POST /getassetissuelistLists all TRC10 tokens.
POST /getassetissuelistbynameLists all TRC10 tokens with a given name.
POST /getavailableunfreezecountReturns how many more Stake 2.0 unstake operations an account can perform.
POST /getbandwidthpricesReturns the history of bandwidth unit prices.
POST /getblockReturns a block header or full block by height or hash.
POST /getblockbyidReturns a block by hash.
POST /getblockbylatestnumReturns the latest blocks, up to a given number.
POST /getblockbylimitnextReturns the blocks in a height range.
POST /getblockbynumReturns a block by height.
POST /getBrokerageReturns the brokerage ratio of a super representative.
POST /getburntrxReturns the total amount of TRX burned for transaction fees.
POST /getcandelegatedmaxsizeReturns the maximum amount of a resource an account can delegate (Stake 2.0).
POST /getcanwithdrawunfreezeamountReturns the unstaked TRX an account can withdraw at a given time (Stake 2.0).
POST /getdelegatedresourceReturns the resources one account delegated to another (Stake 1.0).
POST /getdelegatedresourceaccountindexReturns the resource delegation index of an account (Stake 1.0).
POST /getdelegatedresourceaccountindexv2Returns the resource delegation index of an account (Stake 2.0).
POST /getdelegatedresourcev2Returns the resources one account delegated to another (Stake 2.0).
POST /getenergypricesReturns the history of energy unit prices.
POST /getexchangebyidReturns an exchange pair by ID.
POST /getmarketorderbyaccountReturns the market orders of an account.
POST /getmarketorderbyidReturns a market order by ID.
POST /getmarketorderlistbypairReturns the market orders of a trading pair.
POST /getmarketpairlistLists all market trading pairs.
POST /getmarketpricebypairReturns the prices of a market trading pair.
POST /getnodeinfoReturns information about the node.
POST /getnowblockReturns the latest block.
POST /getpaginatedassetissuelistLists TRC10 tokens with pagination.
POST /getRewardReturns the unclaimed voting rewards of an account.
POST /gettransactionbyidReturns a transaction by ID.
POST /gettransactioncountbyblocknumReturns the number of transactions in a block.
POST /gettransactioninfobyblocknumReturns the receipts of all transactions in a block, including fees and logs.
POST /gettransactioninfobyidReturns the receipt of a transaction, including fee, block height and logs.
POST /isshieldedtrc20contractnotespentChecks whether a shielded TRC20 note has been spent.
POST /listexchangesLists all exchange pairs.
POST /listwitnessesLists all super representatives.
POST /scanshieldedtrc20notesbyivkScans shielded TRC20 notes received, using an incoming viewing key.
POST /scanshieldedtrc20notesbyovkScans shielded TRC20 notes sent, using an outgoing viewing key.
POST /triggerconstantcontractCalls a read-only smart contract function, or simulates a call without broadcasting it.

The gateway lists its supported endpoints at runtime:

Endpoint unavailable?

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