Skip to content

RPC List

For the specific definition of API, please refer to the following link: api/api.proto

Note

SolidityNode is deprecated. Now a FullNode supports all RPCs of a SolidityNode. New developers should deploy FullNode only.

Get account information

rpc GetAccount (Account) returns (Account) {}
Nodes: Fullnode and SolidityNode

TRX transfer

rpc CreateTransaction (TransferContract) returns (Transaction) {}
Nodes: Fullnode

Broadcast transaction

rpc BroadcastTransaction (Transaction) returns (Return) {}
Nodes: Fullnode

Description: Transfer, vote, issuance of token, or participation in token offering. Sending signed transaction information to node, and broadcasting it to the entire network after SR(Super Representatives) verification.

Create an account

rpc CreateAccount (AccountCreateContract) returns (Transaction) {}
Nodes: FullNode

Account name update

rpc UpdateAccount (AccountUpdateContract) returns (Transaction) {}
Nodes: Fullnode

Vote for super representative candidates

rpc VoteWitnessAccount (VoteWitnessContract) returns (Transaction) {}
Nodes: FullNode

Query the ratio of brokerage of the super representative

rpc GetBrokerageInfo (BytesMessage) returns (NumberMessage) {}
Nodes: FullNode

Query unclaimed reward

rpc GetRewardInfo (BytesMessage) returns (NumberMessage) {}
Nodes: FullNode

Update the ratio of brokerage

rpc UpdateBrokerage (UpdateBrokerageContract) returns (TransactionExtention) {}
Nodes: FullNode

Issue a token

rpc CreateAssetIssue (AssetIssueContract) returns (Transaction) {}
Nodes: FullNode

Query of list of super representative candidates

rpc ListWitnesses (EmptyMessage) returns (WitnessList) {}
Nodes: FullNode and SolidityNode

Application for super representative

rpc CreateWitness (WitnessCreateContract) returns (Transaction) {}
Nodes: FullNode

Description: To apply to become TRON’s Super Representative candidate.

Information update of Super Representative candidates

rpc UpdateWitness (WitnessUpdateContract) returns (Transaction) {}
Nodes: FullNode

Description: Update the website url of the SR.

Token transfer

rpc TransferAsset (TransferAssetContract) returns (Transaction){}
Node: FullNode

Participate a token

rpc ParticipateAssetIssue (ParticipateAssetIssueContract) returns (Transaction) {}
Nodes: FullNode

Query the list of nodes connected to the ip of the api

rpc ListNodes (EmptyMessage) returns (NodeList) {}
Nodes: FullNode and SolidityNode

Query the list of all issued tokens

rpc GetAssetIssueList (EmptyMessage) returns (AssetIssueList) {}
Nodes: FullNode and SolidityNode

Query the token issued by a given account

rpc GetAssetIssueByAccount (Account) returns (AssetIssueList) {}
Nodes: FullNode and SolidityNode

Query the token information by token name

rpc GetAssetIssueByName (BytesMessage) returns (AssetIssueContract) {}
Nodes: FullNode and Soliditynode

Query the list of tokens by timestamp

rpc GetAssetIssueListByTimestamp (NumberMessage) returns (AssetIssueList){}
Nodes: SolidityNode

Get current block information

rpc GetNowBlock (EmptyMessage) returns (Block) {}
Nodes: FullNode and SolidityNode

Get a block by block height

rpc GetBlockByNum (NumberMessage) returns (Block) {}
Nodes: FullNode and SolidityNode

Get the total number of transactions

rpc TotalTransaction (EmptyMessage) returns (NumberMessage) {}
Nodes: FullNode and SolidityNode

Query the transaction by transaction id

rpc getTransactionById (BytesMessage) returns (Transaction) {}
Nodes: SolidityNode

Query the transaction by timestamp

rpc getTransactionsByTimestamp (TimeMessage) returns (TransactionList) {}
Nodes: SolidityNode

Freeze TRX

该接口已废弃。

rpc FreezeBalance (FreezeBalanceContract) returns (Transaction) {}
Nodes: FullNode

Unfreeze TRX

rpc UnfreezeBalance (UnfreezeBalanceContract) returns (Transaction) {}
Nodes: FullNode

Block producing reward redemption

rpc WithdrawBalance (WithdrawBalanceContract) returns (Transaction) {}
Nodes: FullNode

Unfreeze token balance

rpc UnfreezeAsset (UnfreezeAssetContract) returns (Transaction) {}
Nodes: FullNode

Query the next maintenance time

rpc GetNextMaintenanceTime (EmptyMessage) returns (NumberMessage) {}
Nodes: FullNode

Query the transaction fee & block information

rpc GetTransactionInfoById (BytesMessage) returns (TransactionInfo) {}
Nodes: SolidityNode

Query block information by block id

rpc GetBlockById (BytesMessage) returns (Block) {}
Nodes: FullNode

Update token information

rpc UpdateAsset (UpdateAssetContract) returns (Transaction) {}
Nodes: Fullnode

Description: Token update can only be initiated by the token issuer to update token description, url, maximum bandwidth consumption by each account and total bandwidth consumption.

Query the list of all the tokens by pagination

rpc GetPaginatedAssetIssueList (PaginatedMessage) returns (AssetIssueList) {}
Nodes: FullNode and SolidityNode

Deploy a smart contract

rpc DeployContract (CreateSmartContract) returns (TransactionExtention) {}
Nodes: FullNode and SolidityNode

Trigger a smart contract

rpc TriggerContract (TriggerSmartContract) returns (TransactionExtention) {}
Nodes: FullNode

Create a shielded transaction

rpc CreateShieldedTransaction (PrivateParameters) returns (TransactionExtention) {}
Nodes: FullNode

Get a Merkle tree information of a note

rpc GetMerkleTreeVoucherInfo (OutputPointInfo) returns (IncrementalMerkleVoucherInfo) {}
Nodes: FullNode

Scan note by ivk

rpc ScanNoteByIvk (IvkDecryptParameters) returns (DecryptNotes) {}
Nodes: FullNode

Scan note by ovk

rpc ScanNoteByOvk (OvkDecryptParameters) returns (DecryptNotes) {}
Nodes: FullNode

Get spending key

rpc GetSpendingKey (EmptyMessage) returns (BytesMessage) {}
Nodes: FullNode

Get expanded spending key

rpc GetExpandedSpendingKey (BytesMessage) returns (ExpandedSpendingKeyMessage) {}
Nodes: FullNode

Get ak from ask

rpc GetAkFromAsk (BytesMessage) returns (BytesMessage) {}
Nodes: FullNode

Get nk from nsk

rpc GetNkFromNsk (BytesMessage) returns (BytesMessage) {}
Nodes: FullNode

Get incoming viewing key

rpc GetIncomingViewingKey (ViewingKeyMessage) returns (IncomingViewingKeyMessage) {}
Nodes: FullNode

Get diversifier

rpc GetDiversifier (EmptyMessage) returns (DiversifierMessage) {}
Nodes: FullNode

Get zen payment address

rpc GetZenPaymentAddress (IncomingViewingKeyDiversifierMessage) returns (PaymentAddressMessage) {}
Nodes: FullNode

Get rcm

rpc GetRcm (EmptyMessage) returns (BytesMessage) {}
Nodes: FullNode

Get a note status of is spent or not

rpc IsSpend (NoteParameters) returns (SpendResult) {}
Nodes: FullNode

Create a shielded transaction without using ask

rpc CreateShieldedTransactionWithoutSpendAuthSig (PrivateParametersWithoutAsk) returns (TransactionExtention) {}
Nodes: FullNode

Create a shielded transaction hash

rpc GetShieldTransactionHash (Transaction) returns (BytesMessage) {}
Nodes: FullNode

Create a signature for a shielded transaction

rpc CreateSpendAuthSig (SpendAuthSigParameters) returns (BytesMessage) {}
Nodes: FullNode

Create a shield nullifier

rpc CreateShieldNullifier (NfParameters) returns (BytesMessage) {}
Nodes: FullNode

Get new shielded address

rpc GetNewShieldedAddress (EmptyMessage) returns (ShieldedAddressInfo){}
Nodes: FullNode

Create shielded contract parameters

rpc CreateShieldedContractParameters (PrivateShieldedTRC20Parameters) returns (ShieldedTRC20Parameters) {}
Nodes: FullNode

Create shielded contract parameters without ask

rpc CreateShieldedContractParametersWithoutAsk (PrivateShieldedTRC20ParametersWithoutAsk) returns (ShieldedTRC20Parameters) {}
Nodes: FullNode

Scan shielded TRC20 notes by ivk

rpc ScanShieldedTRC20NotesbyIvk (IvkDecryptTRC20Parameters) returns (DecryptNotesTRC20) {}
Nodes: FullNode, SolidityNode

Scan shielded TRC20 notes by ovk

rpc ScanShieldedTRC20NotesbyOvk (OvkDecryptTRC20Parameters) returns (DecryptNotesTRC20) {}
Nodes: FullNode, SolidityNode

Get the status of shielded TRC20 note of spent or not

rpc IsShieldedTRC20ContractNoteSpent (NfTRC20Parameters) returns (NullifierResult) {}
Nodes: FullNode, SolidityNode

Get the trigger input for the shielded TRC20

  rpc GetTriggerInputForShieldedTRC20Contract (ShieldedTRC20TriggerContractParameters) returns (BytesMessage) {}
Nodes: FullNode

Create an market order

rpc MarketSellAsset (MarketSellAssetContract) returns (TransactionExtention) {};
Nodes: FullNode

Cancel the order

rpc MarketCancelOrder (MarketCancelOrderContract) returns (TransactionExtention) {};
Nodes: FullNode

Get all orders for the account

rpc GetMarketOrderByAccount (BytesMessage) returns (MarketOrderList) {};
Nodes: FullNode

Get all trading pairs

rpc GetMarketPairList (EmptyMessage) returns (MarketOrderPairList) {};
Nodes: FullNode

Get all orders for the trading pair

rpc GetMarketOrderListByPair (MarketOrderPair) returns (MarketOrderList) {};
Nodes: FullNode

Get all prices for the trading pair

rpc GetMarketPriceByPair (MarketOrderPair) returns (MarketPriceList) {};
Nodes: FullNode

Get order by id

rpc GetMarketOrderById (BytesMessage) returns (MarketOrder) {}; 
Nodes: FullNode

perform a historical balance lookup

rpc GetAccountBalance (AccountBalanceRequest) returns (AccountBalanceResponse){}; 
Nodes: FullNode

fetch all balance-changing transactions in a block

rpc GetBlockBalanceTrace (BlockBalanceTrace.BlockIdentifier) returns (BlockBalanceTrace) {}; 
Nodes: FullNode

get the burn trx amount

rpc GetBurnTrx (EmptyMessage) returns (NumberMessage) {}; 
Nodes: FullNode and SolidityNode

Freeze TRX

rpc FreezeBalanceV2 (FreezeBalanceV2Contract) returns (TransactionExtention) {}
Nodes: FullNode

UnFreeze TRX

rpc UnfreezeBalanceV2 (UnfreezeBalanceV2Contract) returns (TransactionExtention) {}
Nodes: FullNode

Withdraw Staked TRX

rpc WithdrawExpireUnfreeze (WithdrawExpireUnfreezeContract) returns (TransactionExtention) {}
Nodes: FullNode

Delegate Resource

rpc DelegateResource (DelegateResourceContract) returns (TransactionExtention) {}
Nodes: FullNode

UnDelegate Resource

rpc UnDelegateResource (UnDelegateResourceContract) returns (TransactionExtention) {}
Nodes: FullNode

Query transaction information in the pending pool

rpc GetTransactionFromPending (BytesMessage) returns (Transaction) {};
Nodes: FullNode

Query the pending pool transaction id list

rpc GetTransactionListFromPending (EmptyMessage) returns (TransactionIdList) {};
Nodes: FullNode

Query the size of the pending pool

rpc GetPendingSize (EmptyMessage) returns (NumberMessage) {};
Nodes: FullNode

Cancel UnFreeze

rpc CancelAllUnfreezeV2 (CancelAllUnfreezeV2Contract) returns (TransactionExtention) {}
Nodes: FullNode

Get bandwidth unit price

rpc GetBandwidthPrices (EmptyMessage) returns (PricesResponseMessage) {}
Nodes: FullNode

Get energy unit price

rpc GetEnergyPrices (EmptyMessage) returns (PricesResponseMessage) {}
Nodes: FullNode

Get transaction memo fee

rpc GetMemoFee (EmptyMessage) returns (PricesResponseMessage) {}
Nodes: FullNodes