{ "openapi": "3.1.0", "info": { "title": "trongrid-v1-api", "version": "4.8.0" }, "servers": [ { "url": "https://api.shasta.trongrid.io" } ], "components": { "schemas": { "Meta": { "type": "object", "description": "TronGrid response envelope — pagination + timing metadata. Present on every successful TronGrid v1 response.", "properties": { "at": { "type": "integer", "format": "int64", "description": "Server timestamp when the response was generated. (Unit: millisecond)" }, "page_size": { "type": "integer", "description": "Number of items returned in this page." }, "fingerprint": { "type": "string", "description": "Opaque pagination cursor. Pass back as the `fingerprint` query parameter to fetch the next page." }, "links": { "type": "object", "description": "Pagination links.", "properties": { "next": { "type": "string", "description": "URL for the next page (empty if this is the last page)." } } } } } } }, "paths": { "/v1/accounts/{address}": { "get": { "summary": "Get account info by address", "description": "", "operationId": "get-account-info-by-address", "parameters": [ { "name": "address", "in": "path", "description": "Account address. (Format: Base58 or Hex). Example: `TUoHaVjx7n5xz8LwPRDckgFrDWhMhuSuJM`", "schema": { "type": "string" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed results; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed results; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Account address. (Format: hex)" }, "balance": { "type": "integer", "format": "int64", "description": "TRX balance. (Unit: `sun`)" }, "account_name": { "type": "string", "description": "Account name." }, "create_time": { "type": "integer", "format": "int64", "description": "The timestamp for when the account was created. (Unit: millisecond)" }, "is_witness": { "type": "boolean", "description": "Indicates if the account is a Super Representative (SR), an SR Partner or an SR candidate." }, "allowance": { "type": "integer", "format": "int64", "description": "The amount of rewards that can be withdrawn by the account. (Unit: `sun`)" }, "latest_withdraw_time": { "type": "integer", "format": "int64", "description": "The timestamp of the account's last withdrawal of rewards. (Unit: millisecond)" }, "latest_opration_time": { "type": "integer", "format": "int64", "description": "The timestamp of the account's last operation. (Unit: millisecond)" }, "latest_consume_time": { "type": "integer", "format": "int64", "description": "The timestamp of the account's last Bandwidth consumption. (Unit: millisecond)" }, "latest_consume_free_time": { "type": "integer", "format": "int64", "description": "The timestamp of the account's last free Bandwidth consumption. (Unit: millisecond)" }, "net_window_size": { "type": "integer", "format": "int64", "description": "The duration, in blocks, required for staked Bandwidth to fully recover.\\ Note: The value has a decimal precision of 3 if `net_window_optimized` is `true`, otherwise 0." }, "net_window_optimized": { "type": "boolean", "description": "Whether the Bandwidth recovery window optimization is enabled." }, "account_resource": { "type": "object", "properties": { "latest_consume_time_for_energy": { "type": "integer", "format": "int64", "description": "The timestamp of the account's last Energy consumption. (Unit: millisecond)" }, "acquired_delegated_frozen_balance_for_energy": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by other accounts for this account's energy. (Unit: sun, For Stake 1.0)" }, "delegated_frozen_balance_for_energy": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by this account for other accounts' energy. (Unit: sun, For Stake 1.0)" }, "energy_window_size": { "type": "integer", "format": "int64", "description": "The duration, in blocks, required for Energy to fully recover. Note: The value has a decimal precision of 3 if `energy_window_optimized` is `true`, otherwise 0." }, "acquired_delegated_frozenV2_balance_for_energy": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by other accounts for this account's Energy. (Unit: sun, For Stake 2.0)" }, "delegated_frozenV2_balance_for_energy": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by this account for other accounts' Energy. (Unit: sun, For Stake 2.0)" }, "energy_window_optimized": { "type": "boolean", "description": "Whether the Energy recovery window optimization is enabled." }, "frozen_balance_for_energy": { "type": "object", "properties": { "frozen_balance": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked for Energy by this account. (Unit: sun, For Stake 1.0)" }, "expire_time": { "type": "integer", "format": "int64", "description": "The timestamp when the `unstake` operation becomes available for the staked Energy. (Unit: millisecond, For Stake 1.0)" } } }, "energy_usage": { "type": "integer", "format": "int64", "description": "The amount of Energy used." } } }, "frozen": { "type": "array", "items": { "type": "object", "properties": { "frozen_balance": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked for Bandwidth by this account. (Unit: sun, For Stake 1.0)" }, "expire_time": { "type": "integer", "format": "int64", "description": "The timestamp when the `unstake` operation becomes available for the staked Bandwidth. (Unit: millisecond, For Stake 1.0)" } } } }, "owner_permission": { "type": "object", "properties": { "permission_name": { "type": "string", "description": "Owner permission name." }, "threshold": { "type": "integer", "format": "int32", "description": "The minimum combined weight of signatures required to validate an operation using this permission." }, "keys": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address associated with the owner permission." }, "weight": { "type": "integer", "format": "int32", "description": "The signature weight of the corresponding address." } } } } } }, "active_permission": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the permission. (Value: `Active`)" }, "id": { "type": "integer", "format": "int32", "description": "Active Permission ID. (Automatically assigned from 2)" }, "permission_name": { "type": "string", "description": "Permission name." }, "threshold": { "type": "integer", "format": "int32", "description": "The minimum combined weight of signatures required to validate an operation using this permission." }, "operations": { "type": "string", "description": "A string representing the operations allowed by this permission. Note: This is a 32-byte hex string where each bit corresponds to a specific operation. See details [here](https://developers.tron.network/docs/multi-signature#active-permissions) ." }, "keys": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address associated with this active permission." }, "weight": { "type": "integer", "format": "int32", "description": "The signature weight of the address." } } } } } } }, "witness_permission": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the permission. (Value: `Witness`)" }, "id": { "type": "integer", "format": "int32", "description": "The fixed ID for the witness permission. (Value: `1`)" }, "permission_name": { "type": "string", "description": "Permission name." }, "threshold": { "type": "integer", "format": "int32", "description": "Witness Permission threshold." }, "keys": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address of the key associated with this witness permission." }, "weight": { "type": "integer", "format": "int32", "description": "The signature weight of the address." } } } } } }, "frozenV2": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked to obtain the resource type specified by `data.frozenV2[i].type`. (Unit: sun, For Stake 2.0)" }, "type": { "type": "string", "description": "The type of resource obtained through staking. (Enum: `BANDWIDTH` or `ENERGY`)" } } } }, "acquired_delegated_frozenV2_balance_for_bandwidth": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by other accounts for this account's Bandwidth. (Unit: sun, For Stake 2.0)" }, "delegated_frozenV2_balance_for_bandwidth": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by this account for other accounts' Bandwidth. (Unit: sun, For Stake 2.0)" }, "acquired_delegated_frozen_balance_for_bandwidth": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by other accounts for this account's Bandwidth. (Unit: sun, For Stake 1.0)" }, "delegated_frozen_balance_for_bandwidth": { "type": "integer", "format": "int64", "description": "The total amount of TRX staked by this account for other accounts' Bandwidth. (Unit: sun, For Stake 1.0)" }, "assetV2": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "TRC-10 Token ID." }, "value": { "type": "integer", "format": "int64", "description": "TRC-10 Token balance." } } } }, "net_usage": { "type": "integer", "format": "int64", "description": "The amount of Bandwidth used." }, "free_net_usage": { "type": "integer", "format": "int64", "description": "The amount of free Bandwidth used." }, "free_asset_net_usageV2": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The TRC-10 Token ID." }, "value": { "type": "integer", "format": "int64", "description": "The total free Bandwidth usage attributed to this TRC-10 token." } } } }, "trc20": { "type": "array", "description": "TRC-20 balance held by this account.", "items": { "type": "object", "description": "A single-key map: TRC-20 contract address (Base58) -> raw balance (string). `decimals`/`name`/`symbol` are not returned; query `GET /v1/contracts/{contractAddress}` to convert." } }, "votes": { "type": "array", "items": { "type": "object", "properties": { "vote_address": { "type": "string", "description": "The address of the Super Representative (SR) that this account has voted for." }, "vote_count": { "type": "integer", "format": "int64", "description": "The number of votes cast for the the SR address." } } } }, "unfrozenV2": { "type": "array", "description": "Stake 2.0 unstaking details. Returned conditionally (only when the account has pending unstaked amounts).", "items": { "type": "object", "properties": { "unfreeze_amount": { "type": "integer", "format": "int64", "description": "The amount of TRX being unstaked. (Unit: sun, For Stake 2.0)" }, "unfreeze_expire_time": { "type": "integer", "format": "int64", "description": "The timestamp when the unstaked TRX can be withdrawn. (Unit: millisecond, For Stake 2.0)" } } } } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/accounts/{address}/transactions": { "get": { "summary": "Get transaction info by account address", "description": "", "operationId": "get-transaction-info-by-account-address", "parameters": [ { "name": "address", "in": "path", "description": "Account address. (Format: Base58 or Hex). Example: `TUoHaVjx7n5xz8LwPRDckgFrDWhMhuSuJM`", "schema": { "type": "string" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed transactions; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed transactions; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "only_to", "in": "query", "description": "Set to `true` to return only transactions sent to the address specified in the path. (Default: `false`)", "schema": { "type": "boolean" } }, { "name": "only_from", "in": "query", "description": "Set to `true` to return only transactions sent from the address specified in the path. (Default: `false`)", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "The maximum number of transactions to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default). Also accepts `timestamp,asc` / `timestamp,desc`.", "schema": { "type": "string" } }, { "name": "min_timestamp", "in": "query", "description": "The minimum block timestamp to filter by. (Unit: milliseconds, Default: 0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_timestamp", "in": "query", "description": "The maximum block timestamp to filter by. (Unit: milliseconds, Default: current time)", "schema": { "type": "integer", "format": "int64" } }, { "name": "min_block_timestamp", "in": "query", "description": "Synonym for `min_timestamp`. (Unit: milliseconds, integer epoch.)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_block_timestamp", "in": "query", "description": "Synonym for `max_timestamp`. (Unit: milliseconds, integer epoch.)", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "txID": { "type": "string", "description": "Transaction ID (Hash)." }, "blockNumber": { "type": "integer", "format": "int32", "description": "The block number." }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "ret": { "type": "array", "items": { "type": "object", "properties": { "contractRet": { "type": "string", "description": "Transaction execution result. (e.g. `SUCCESS`)" }, "fee": { "type": "integer", "format": "int64", "description": "Transaction fee. (Unit: sun)" } } } }, "signature": { "type": "array", "items": { "type": "string" }, "description": "Transaction signature." }, "raw_data_hex": { "type": "string", "description": "The transaction's raw data. (Format: hex)" }, "raw_data": { "type": "object", "description": "Transaction content. See [here](https://developers.tron.network/docs/tron-protocol-transaction) for details." }, "energy_fee": { "type": "integer", "format": "int64", "description": "The amount of TRX burned for Energy. (Unit: sun)" }, "energy_usage": { "type": "integer", "format": "int64", "description": "The amount of Energy consumed by the sender's account." }, "energy_usage_total": { "type": "integer", "format": "int64", "description": "The total amount of Energy consumed by the transaction." }, "net_fee": { "type": "integer", "format": "int64", "description": "The amount of TRX burned to pay for the Bandwidth." }, "net_usage": { "type": "integer", "format": "int64", "description": "The amount of Bandwidth consumed." }, "internal_transactions": { "type": "array", "items": { "type": "object", "description": "Internal transaction object. See the internal-transactions endpoints for element fields." }, "description": "An array of internal transactions. See [here](https://developers.tron.network/docs/tron-protocol-transaction#internal-transactions) for details." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/accounts/{address}/transactions/trc20": { "get": { "summary": "Get TRC-20 transaction info by account address", "description": "Get the historical TRC-20, TRC-721 transfer records and authorization records of an account", "operationId": "get-trc20-transaction-info-by-account-address", "parameters": [ { "name": "address", "in": "path", "description": "Account address. (Format: Base58 or Hex). Example: `TUoHaVjx7n5xz8LwPRDckgFrDWhMhuSuJM`", "schema": { "type": "string" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed transactions; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed transactions; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "The maximum number of transactions to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default).", "schema": { "type": "string" } }, { "name": "min_timestamp", "in": "query", "description": "The minimum block timestamp to filter by. (Unit: milliseconds, Default: 0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_timestamp", "in": "query", "description": "The maximum block timestamp to filter by. (Unit: milliseconds, Default: current time)", "schema": { "type": "integer", "format": "int64" } }, { "name": "contract_address", "in": "query", "description": "Contract address in Base58 or Hex format.", "schema": { "type": "string" } }, { "name": "only_to", "in": "query", "description": "Set to `true` to return only transactions sent to the address specified in the path. (Default: `false`)", "schema": { "type": "boolean" } }, { "name": "only_from", "in": "query", "description": "Set to `true` to return only transactions sent from the address specified in the path. (Default: `false`)", "schema": { "type": "boolean" } }, { "name": "min_block_timestamp", "in": "query", "description": "Synonym for `min_timestamp`. (Unit: milliseconds, integer epoch.)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_block_timestamp", "in": "query", "description": "Synonym for `max_timestamp`. (Unit: milliseconds, integer epoch.)", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "transaction_id": { "type": "string", "description": "Transaction hash." }, "token_info": { "type": "object", "properties": { "symbol": { "type": "string", "description": "TRC-20 token symbol." }, "address": { "type": "string", "description": "TRC-20 contract address. (Encoding: Base58.)" }, "decimals": { "type": "integer", "format": "int32", "description": "TRC-20 token decimals." }, "name": { "type": "string", "description": "TRC-20 token name." } } }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "from": { "type": "string", "description": "The `from` address of the transaction. (Encoding: Base58, starts with `T`.)" }, "to": { "type": "string", "description": "The `to` address of the transaction. (Encoding: Base58, starts with `T`.)" }, "type": { "type": "string", "description": "The TRC-20 event type, typically `Transfer` (capitalized event name, not a lowercase function name)." }, "value": { "type": "string", "description": "The raw transferred amount (smallest unit, integer string). Divide by 10^`token_info.decimals` to get the human-readable amount. This value is NOT denominated in sun." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/accounts/{address}/internal-transactions": { "get": { "summary": "Get internal transactions by address", "description": "", "operationId": "get-internal-transactions-by-address", "parameters": [ { "name": "address", "in": "path", "description": "Account address. (Format: Base58 or Hex). Example: `TUoHaVjx7n5xz8LwPRDckgFrDWhMhuSuJM`", "schema": { "type": "string" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed transactions; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed transactions; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "only_to", "in": "query", "description": "Set to `true` to return only transactions sent to the address specified in the path. (Default: `false`) Cannot be used simultaneously with `only_from`.", "schema": { "type": "boolean" } }, { "name": "only_from", "in": "query", "description": "Set to `true` to return only transactions sent from the address specified in the path. (Default: `false`) Cannot be used simultaneously with `only_to`.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "The maximum number of transactions to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default). Also accepts `timestamp,asc` / `timestamp,desc`.", "schema": { "type": "string" } }, { "name": "min_timestamp", "in": "query", "description": "The minimum block timestamp to filter by. (Unit: milliseconds, Default: 0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_timestamp", "in": "query", "description": "The maximum block timestamp to filter by. (Unit: milliseconds, Default: current time)", "schema": { "type": "integer", "format": "int64" } }, { "name": "min_block_timestamp", "in": "query", "description": "Synonym for `min_timestamp`. (Unit: milliseconds, integer epoch.)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_block_timestamp", "in": "query", "description": "Synonym for `max_timestamp`. (Unit: milliseconds, integer epoch.)", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internal_tx_id": { "type": "string", "description": "The unique ID for the internal transaction." }, "data": { "type": "object", "properties": { "note": { "type": "string", "description": "The type of instruction, such as `call`, `create`, `suicide`, `freezeBalanceV2ForEnergy`, `freezeBalanceV2ForBandwidth`, or `unfreezeBalanceV2ForBandwidth`." }, "rejected": { "type": "boolean", "description": "Whether the internal transaction failed during execution. `true` signifies failure." }, "call_value": { "type": "object", "description": "Transfer amount map `{ \"_\": }`. Key `_` denotes TRX (amount in sun); other keys are TRC-10 token IDs. Always present." } } }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "to_address": { "type": "string", "description": "The recipient's address." }, "tx_id": { "type": "string", "description": "The transaction hash of the parent transaction that initiated this internal transaction." }, "from_address": { "type": "string", "description": "The sender's address. (Format: Hex, starts with `41`.)" } } } }, "success": { "type": "boolean", "description": "Whether the request succeeded. `true` on success." }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/transactions/{transactionId}/internal-transactions": { "get": { "summary": "Get internal transactions by transaction ID", "description": "", "operationId": "get-internal-transactions-by-transactionid", "parameters": [ { "name": "transactionId", "in": "path", "description": "The unique ID for the parent transaction.", "schema": { "type": "string" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed transactions; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed transactions; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internal_tx_id": { "type": "string", "description": "The unique ID for the internal transaction." }, "data": { "type": "object", "properties": { "note": { "type": "string", "description": "The type of instruction, such as `call`, `create`, `suicide`, `freezeBalanceV2ForEnergy`, `freezeBalanceV2ForBandwidth`, or `unfreezeBalanceV2ForBandwidth`." }, "rejected": { "type": "boolean", "description": "Whether the internal transaction failed during execution. `true` signifies failure." }, "call_value": { "type": "object", "description": "Transfer amount map `{ \"_\": }`. Key `_` denotes TRX (amount in sun); other keys are TRC-10 token IDs. Always present." } } }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "to_address": { "type": "string", "description": "The recipient's address." }, "tx_id": { "type": "string", "description": "The transaction hash of the parent transaction that initiated this internal transaction." }, "from_address": { "type": "string", "description": "The sender's address." } } } }, "success": { "type": "boolean", "description": "Whether the request succeeded. `true` on success." }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/assets": { "get": { "summary": "List all assets (TRC-10 tokens) on chain", "description": "", "operationId": "list-all-assets-trc10-tokens-on-chain", "parameters": [ { "name": "order_by", "in": "query", "description": "Sort options: `total_supply,asc|desc`, `start_time,asc|desc`, `end_time,asc|desc`, `id,asc|desc` (default: `id,desc`).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of assets to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "fingerprint of the last asset returned by the previous page; when using it, the other parameters and filters should remain the same", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The TRC-10 Token ID." }, "abbr": { "type": "string", "description": "The TRC-10 Token Symbol." }, "description": { "type": "string", "description": "Token description." }, "name": { "type": "string", "description": "Token name." }, "num": { "type": "integer", "format": "int32", "description": "Define the price by the ratio of trx_num/num. (The unit of 'trx_num' is sun)" }, "precision": { "type": "integer", "format": "int64", "description": "Token precision, i.e. the number of decimal places the token supports." }, "url": { "type": "string", "description": "The URL of the token's official website." }, "total_supply": { "type": "integer", "description": "Total supply. May reach the int64 upper bound `9223372036854775807` (> JS safe integer 2^53-1); treat as a string client-side to avoid precision loss. Actual quantity = total_supply / 10^`precision`.", "format": "int64" }, "trx_num": { "type": "integer", "description": "Define the price by the ratio of trx_num/num. (The unit of 'trx_num' is sun)", "format": "int64" }, "vote_score": { "type": "integer", "format": "int32", "description": "The vote score of the TRC-10 token." }, "owner_address": { "type": "string", "description": "Token issuer address. (Encoding: Hex, starts with `41`, 42 chars; not Base58.)" }, "start_time": { "type": "integer", "format": "int64", "description": "ICO start time. (Unit: millisecond)" }, "end_time": { "type": "integer", "format": "int64", "description": "ICO end time. (Unit: millisecond)" } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/assets/{name}/list": { "get": { "summary": "Get assets by name", "description": "NOTE: Multiple assets may have the same name.", "operationId": "get-asset-by-name", "parameters": [ { "name": "name", "in": "path", "description": "Name of the asset(s). Example: `btt`", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "description": "The maximum number of assets to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "fingerprint of the last asset returned by the previous page; when using it, the other parameters and filters should remain the same", "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default).", "schema": { "type": "string" } }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed results. (Default: `false`)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The TRC-10 Token ID." }, "abbr": { "type": "string", "description": "The TRC-10 Token Symbol." }, "description": { "type": "string", "description": "Token description." }, "name": { "type": "string", "description": "Token name." }, "num": { "type": "integer", "format": "int32", "description": "Define the price by the ratio of trx_num/num. (The unit of 'trx_num' is sun)" }, "precision": { "type": "integer", "format": "int64", "description": "Token precision, i.e. the number of decimal places the token supports." }, "url": { "type": "string", "description": "The URL of the token's official website." }, "total_supply": { "type": "integer", "description": "Total supply. May reach the int64 upper bound `9223372036854775807` (> JS safe integer 2^53-1); treat as a string client-side to avoid precision loss. Actual quantity = total_supply / 10^`precision`.", "format": "int64" }, "trx_num": { "type": "integer", "description": "Define the price by the ratio of trx_num/num. (The unit of 'trx_num' is sun)", "format": "int64" }, "vote_score": { "type": "integer", "format": "int32", "description": "The vote score of the TRC-10 token." }, "owner_address": { "type": "string", "description": "Token issuer address. (Encoding: Hex, starts with `41`, 42 chars; not Base58.)" }, "start_time": { "type": "integer", "format": "int64", "description": "ICO start time. (Unit: millisecond)" }, "end_time": { "type": "integer", "format": "int64", "description": "ICO end time. (Unit: millisecond)" } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/assets/{identifier}": { "get": { "summary": "Get assets by ID or issuer", "description": "", "operationId": "get-asset-by-id-or-issuer", "parameters": [ { "name": "identifier", "in": "path", "description": "Id of the asset or the owner address of the asset in base58 or hex. Example: `1000996` or `41d7198920ecc8d0a522ab261ef0abae4bb09f29f9` Note: integers in `1000001`-`2000000` are parsed as asset IDs; otherwise as an address (Base58 `T`/34 chars or Hex `41`/42 chars).", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The TRC-10 Token ID." }, "abbr": { "type": "string", "description": "The TRC-10 Token Symbol." }, "description": { "type": "string", "description": "Token description." }, "name": { "type": "string", "description": "Token name." }, "num": { "type": "integer", "format": "int32", "description": "Define the price by the ratio of trx_num/num. (The unit of 'trx_num' is sun)" }, "precision": { "type": "integer", "format": "int64", "description": "Token precision, i.e. the number of decimal places the token supports." }, "url": { "type": "string", "description": "The URL of the token's official website." }, "total_supply": { "type": "integer", "description": "Total supply. May reach the int64 upper bound `9223372036854775807` (> JS safe integer 2^53-1); treat as a string client-side to avoid precision loss. Actual quantity = total_supply / 10^`precision`.", "format": "int64" }, "trx_num": { "type": "integer", "description": "Define the price by the ratio of trx_num/num. (The unit of 'trx_num' is sun)", "format": "int64" }, "vote_score": { "type": "integer", "format": "int32", "description": "The vote score of the TRC-10 token." }, "owner_address": { "type": "string", "description": "Token issuer address. (Encoding: Hex, starts with `41`, 42 chars; not Base58.)" }, "start_time": { "type": "integer", "format": "int64", "description": "ICO start time. (Unit: millisecond)" }, "end_time": { "type": "integer", "format": "int64", "description": "ICO end time. (Unit: millisecond)" } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/contracts/{contractAddress}/transactions": { "get": { "summary": "Get transaction info by contract address", "description": "", "operationId": "get-transaction-info-by-contract-address", "parameters": [ { "name": "contractAddress", "in": "path", "description": "The address of contract (format: Base58 or Hex). Example: `TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs`", "schema": { "type": "string" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed transactions; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed transactions; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "min_timestamp", "in": "query", "description": "The minimum block timestamp to filter by. (Unit: milliseconds, Default: 0)", "schema": { "type": "string", "format": "date-time" } }, { "name": "max_timestamp", "in": "query", "description": "The maximum block timestamp to filter by. (Unit: milliseconds, Default: current time)", "schema": { "type": "string", "format": "date-time" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default).", "schema": { "type": "string" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of transactions to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "txID": { "type": "string", "description": "Transaction ID(Hash)." }, "blockNumber": { "type": "string", "description": "The block number." }, "block_timestamp": { "type": "string", "description": "The block timestamp.(Unit:millisecond)" }, "ret": { "type": "array", "items": { "type": "object", "properties": { "contractRet": { "type": "string", "description": "Transaction execution result. (e.g. `SUCCESS`, `REVERT`)" }, "fee": { "type": "integer", "format": "int64", "description": "Transaction fee.(Unit:sun)" } } } }, "signature": { "type": "array", "items": { "type": "string" }, "description": "Transaction signature." }, "raw_data_hex": { "type": "string", "description": "The transaction's raw data. (Format: hex)" }, "raw_data": { "type": "object", "description": "Transaction content. See [here](https://developers.tron.network/docs/tron-protocol-transaction) for details.", "properties": { "fee_limit": { "type": "integer", "format": "int64", "description": "The transaction's `FeeLimit`. See [here](https://developers.tron.network/docs/feelimit) for details. (Unit: sun)" }, "expiration": { "type": "integer", "format": "int64", "description": "Transaction expiration time. (Unit: millisecond)" }, "timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "ref_block_bytes": { "type": "string", "description": "The last two bytes of the reference block's number (height), used for transaction validation." }, "ref_block_hash": { "type": "string", "description": "Bytes 8 to 16 of the reference block's hash, used for transaction validation." } } }, "energy_fee": { "type": "integer", "format": "int64", "description": "The amount of TRX burned for Energy. (Unit: sun)" }, "energy_usage": { "type": "integer", "format": "int64", "description": "The amount of Energy consumed by the sender's account." }, "energy_usage_total": { "type": "integer", "format": "int64", "description": "The total amount of Energy consumed by the transaction." }, "net_fee": { "type": "integer", "format": "int64", "description": "The amount of TRX burned to pay for the Bandwidth." }, "net_usage": { "type": "integer", "format": "int64", "description": "The amount of Bandwidth consumed." }, "internal_transactions": { "type": "array", "items": { "type": "object", "properties": { "internal_tx_id": { "type": "string", "description": "The unique ID for the internal transaction." }, "tx_id": { "type": "string", "description": "The hash of the parent transaction." }, "from_address": { "type": "string", "description": "The sender's address. (Format: Hex, starts with `41`.)" }, "to_address": { "type": "string", "description": "The recipient's address. (Format: Hex, starts with `41`.)" }, "data": { "type": "object", "properties": { "note": { "type": "string", "description": "The instruction type, e.g. `call`, `create`, `suicide`." }, "reject": { "type": "boolean", "description": "Whether the internal transaction failed. Note: on this endpoint the wire field is `reject` (an implementation typo of the canonical `rejected`)." }, "call_value": { "type": "array", "items": { "type": "object", "properties": { "call_value": { "type": "integer", "format": "int64", "description": "Transfer amount. (Unit: sun)" }, "token_id": { "type": "string", "description": "Token ID. `_` denotes TRX (decimals 6); otherwise a TRC-10 token ID." } } } } } } } }, "description": "An array of internal transactions. See [here](https://developers.tron.network/docs/tron-protocol-transaction#internal-transactions) for details." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/contracts/{contractAddress}/tokens": { "get": { "summary": "Get TRC-20 token holder balances", "description": "", "operationId": "get-trc20-token-holder-balances", "parameters": [ { "name": "contractAddress", "in": "path", "description": "The address of contract (format: Base58 or Hex). Example: `TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs`", "schema": { "type": "string" }, "required": true }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of token holders to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "order_by", "in": "query", "description": "Sort order: `balance,asc` or `balance,desc` (default).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "description": "A single-key map: holder address (Base58, `T...`) -> balance (string, scaled by token decimals)." }, "description": "The balance of the TRC-20 holder." }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The timestamp for when the API response was generated. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "A fingerprint of the last transaction on this page, used to fetch the next page of results." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The complete URL to request the next page of results. `null` if this is the last page." } } } } } } }, "examples": { "Result": { "value": "" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/transactions/{transactionID}/events": { "get": { "summary": "Get events by transaction id", "description": "", "operationId": "get-events-by-transaction-id", "parameters": [ { "name": "transactionID", "in": "path", "description": "The specific transaction hash to query.\nExample: `aee87b7bb3e375c7e5e96f8b1a770c1fac60d483f56267fd77e663a3e9512a1a`", "schema": { "type": "string" }, "required": true }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed events; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed events; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "block_number": { "type": "integer", "format": "int64", "description": "The block number." }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "caller_contract_address": { "type": "string", "description": "Same as `data.[0].contract_address` for backward compatibility." }, "contract_address": { "type": "string", "description": "The address of the contract that emitted the event." }, "event_index": { "type": "integer", "description": "The event's index within the transaction's event log." }, "event_name": { "type": "string", "description": "The event name." }, "event": { "type": "string", "description": "The event signature used to parse indexed and non-indexed parameters. (e.g., `Transfer(address,address,uint256)`)" }, "transaction_id": { "type": "string", "description": "Transaction hash." }, "result": { "type": "object", "description": "The event's parameters, including both indexed and non-indexed parameters." }, "result_type": { "type": "object", "description": "The type of parameter." }, "_unconfirmed": { "type": "boolean", "description": "Whether the transaction is unconfirmed. `true` means unconfirmed." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)." } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/contracts/{address}/events": { "get": { "summary": "Get events by contract address", "description": "", "operationId": "get-events-by-contract-address", "parameters": [ { "name": "address", "in": "path", "description": "Contract address. (Format: Base58 or Hex). Example: `TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs`", "schema": { "type": "string" }, "required": true }, { "name": "event_name", "in": "query", "description": "The event name to filter by.\nExample: `Transfer`", "schema": { "type": "string", "default": "Transfer" } }, { "name": "block_number", "in": "query", "description": "The specific block number to query.\nExample: `61840405` Accepts a specific block height or `latest`.", "schema": { "type": "string" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed events; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed events; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "min_timestamp", "in": "query", "description": "The minimum block timestamp to filter by. (Unit: milliseconds, Default: 0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "max_timestamp", "in": "query", "description": "The maximum block timestamp to filter by. (Unit: milliseconds, Default: current time)", "schema": { "type": "integer", "format": "int64" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default).", "schema": { "type": "string" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of events to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "block_number": { "type": "integer", "format": "int64", "description": "The block number" }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "caller_contract_address": { "type": "string", "description": "Same as data.[0].contract_address for backward compatibility." }, "contract_address": { "type": "string", "description": "The address of the contract that emitted the event." }, "event_index": { "type": "integer", "description": "The event's index within the transaction's event log." }, "event_name": { "type": "string", "description": "The event name" }, "event": { "type": "string", "description": "The event signature used to parse indexed and non-indexed parameters. (e.g., `Transfer(address,address,uint256)`)" }, "transaction_id": { "type": "string", "description": "Transaction hash." }, "result": { "type": "object", "description": "The event's parameters, including both indexed and non-indexed parameters." }, "result_type": { "type": "object", "description": "The type of parameter" }, "_unconfirmed": { "type": "boolean", "description": "Whether the transaction is unconfirmed. `true` means unconfirmed." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "fingerprint": { "type": "string", "description": "Pagination cursor (present when a full page is returned)." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "URL for the next page (conditional)." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/blocks/{block_number}/events": { "get": { "summary": "Get events by block number", "description": "", "operationId": "get-events-by-block-number", "parameters": [ { "name": "block_number", "in": "path", "description": "The block number to query events for.\nExample: `61840405`", "schema": { "type": "integer", "format": "int64" }, "required": true }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed events; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "The maximum number of events to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "block_number": { "type": "integer", "format": "int64", "description": "The block number" }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)." }, "caller_contract_address": { "type": "string", "description": "Same as `data.[0].contract_address` for backward compatibility." }, "contract_address": { "type": "string", "description": "The address of the contract that emitted the event." }, "event_index": { "type": "integer", "description": "The event's index within the transaction's event log." }, "event_name": { "type": "string", "description": "The event name" }, "event": { "type": "string", "description": "The event signature used to parse indexed and non-indexed parameters. (e.g., `Transfer(address,address,uint256)`)" }, "transaction_id": { "type": "string", "description": "Transaction hash." }, "result": { "type": "object", "description": "The event's parameters, including both indexed and non-indexed parameters." }, "result_type": { "type": "object", "description": "The type of parameter" }, "_unconfirmed": { "type": "boolean", "description": "Whether the transaction is unconfirmed. `true` means unconfirmed." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)." }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/blocks/latest/events": { "get": { "summary": "Get events of latest block", "description": "", "operationId": "get-events-by-latest-block", "parameters": [ { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed events; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "block_number": { "type": "integer", "format": "int64", "description": "The block number." }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The block timestamp. (Unit: millisecond)" }, "caller_contract_address": { "type": "string", "description": "Same as `data.[i].contract_address` for backward compatibility." }, "contract_address": { "type": "string", "description": "The address of the contract that emitted the event." }, "event_index": { "type": "integer", "description": "The event's index within the transaction's event log." }, "event_name": { "type": "string", "description": "The event name." }, "event": { "type": "string", "description": "The event signature used to parse indexed and non-indexed parameters. (e.g., `Transfer(address,address,uint256)`)" }, "transaction_id": { "type": "string", "description": "Transaction hash." }, "result": { "type": "object", "description": "The event's parameters, including both indexed and non-indexed parameters." }, "result_type": { "type": "object", "description": "The type of parameter." }, "_unconfirmed": { "type": "boolean", "description": "Whether the transaction is unconfirmed. `true` means unconfirmed." } } } }, "success": { "type": "boolean", "description": "Whether the API request was successful." }, "meta": { "type": "object", "properties": { "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "at": { "type": "integer", "format": "int64", "description": "The API response timestamp. (Unit: millisecond)" }, "fingerprint": { "type": "string", "description": "The fingerprint for paginating to the next page." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The URL for the next page of results." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/blocks/{blockNum}/stats": { "get": { "summary": "Get block statistics", "description": "Retrieves detailed statistical information for a specific block, including transaction counts and resource consumption.", "operationId": "get-block-statistics", "parameters": [ { "name": "blockNum", "in": "path", "description": "The specific block number to query.", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "get_tx_detail", "in": "query", "description": "Set to `true` to include detailed transaction statistics (`txStat`) in the response. (Default: `false`)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "txStat": { "type": "object", "properties": { "trxAnd10TransferCount": { "type": "integer", "description": "The number of TRX and TRC-10 transfer transactions." }, "trc20And721TransferCount": { "type": "integer", "description": "The number of TRC-20 and TRC-721 transfer transactions." }, "trc1155TransferCount": { "type": "integer", "description": "The number of TRC-1155 transfer transactions." }, "transferCount": { "type": "integer", "description": "The number of all transfer-type transactions." }, "failTxCount": { "type": "integer", "description": "The number of failed transactions." }, "internalTxCount": { "type": "integer", "description": "The number of all internal transactions generated within the block." }, "containInternalTxCount": { "type": "integer", "description": "The number of transactions that contain at least one internal transaction." }, "contractTypeDistribute": { "type": "object", "description": "The total count for each transaction type in the block, keyed by enum ID (see [here](https://github.com/tronprotocol/java-tron/blob/develop/protocol/src/main/protos/core/Tron.proto#L338) for details)." } }, "description": "An object containing transaction statistics. Only returned if `get_tx_detail` is set to `true`." }, "feeStat": { "type": "object", "properties": { "netUsage": { "type": "integer", "description": "The total Bandwidth used in the block." }, "energyUsage": { "type": "integer", "description": "The total Energy consumed in the block." }, "otherFee": { "type": "number", "description": "Total fee (excluding Bandwidth and Energy) for all other operations. (Unit: TRX)" }, "srCandidateRegistrationFee": { "type": "number", "description": "Total fee for Super Representative (SR) candidate registration. (Unit: TRX)" }, "accountActivationFee": { "type": "number", "description": "Total fee for account activations. (Unit: TRX)" }, "permissionUpdateFee": { "type": "number", "description": "Total fee for updating account permissions. (Unit: TRX)" }, "multiSignatureFee": { "type": "number", "description": "Total fee for a multi-signature transaction. (Unit: TRX)" }, "memoFee": { "type": "number", "description": "Total fee for including a memo in a transaction. (Unit: TRX)" }, "trc10AssetIssueFee": { "type": "number", "description": "Total fee for issuing a TRC-10 token. (Unit: TRX)" }, "dexPairCreateFee": { "type": "number", "description": "Total fee for creating a DEX trading pair. (Unit: TRX)" }, "dexOrderSellFee": { "type": "number", "description": "Total fee for creating a DEX sell order. (Unit: TRX)" }, "dexOrderCancelFee": { "type": "number", "description": "Total fee for cancelling a DEX order. (Unit: TRX)" }, "energyBurnFeeSunAmt": { "type": "number", "description": "The total amount of TRX burned for Energy. (Unit: TRX) Note: the field name contains `Sun`, but the value is already TRX (divided by 1e6), e.g. `19.672` = 19.672 TRX." }, "bandwidthConsumedFromBurnCnt": { "type": "integer", "description": "The Bandwidth obtained by burning TRX." }, "freeBandwidthUsageCnt": { "type": "integer", "description": "The total usage of staked and free Bandwidth." }, "bandwidthBurnFeeSunAmt": { "type": "number", "description": "The total amount of TRX burned for Bandwidth. (Unit: TRX) Note: the field name contains `Sun`, but the value is already TRX (divided by 1e6), e.g. `19.672` = 19.672 TRX." }, "energyConsumedFromOwnerBurnCnt": { "type": "integer", "description": "The total Energy usage obtained by the transaction owner burning TRX." }, "freeEnergyUsageCnt": { "type": "integer", "description": "The total usage of staked Energy." } }, "description": "An object containing fee and resource consumption statistics." } } } }, "success": { "type": "boolean", "description": "Whether the request succeeded. `true` on success." }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/accounts/{address}/trc20/balance": { "get": { "description": "", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "description": "TRC-20 balance(s) for an address.", "properties": { "data": { "type": "array", "items": { "type": "object", "description": "A single-key map: TRC-20 contract address (Base58) -> raw balance (string). Tokens with zero balance are omitted. `decimals`/`name`/`symbol` are NOT returned; query `GET /v1/contracts/{contractAddress}` to convert." } }, "success": { "type": "boolean" }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "examples": { "Result": { "value": "{}" } } } } } }, "parameters": [ { "in": "path", "name": "address", "schema": { "type": "string" }, "required": true, "description": "Account address. (Format: Base58 or Hex). Example: `TUoHaVjx7n5xz8LwPRDckgFrDWhMhuSuJM`" }, { "in": "query", "name": "contract_address", "schema": { "type": "string" }, "description": "The TRC-20 contract address for balance inquiry. (Format: Base58) — example: `TPYmHEhy5n8TCEfYGqW2rPxsghSfzghPDn`" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32" }, "description": "The maximum number of TRC-20 balances to return per page. (Default: 20, Max: 200)" }, { "name": "fingerprint", "in": "query", "description": "Pagination cursor from the `meta.fingerprint` field of a previous response.", "schema": { "type": "string" } } ], "operationId": "get_v1-accounts-address-trc20-balance", "summary": "Get TRC-20 token balances by address" } }, "/v1/contracts/{contractAddress}/internal-transactions": { "get": { "summary": "Get internal transactions by contract address", "description": "", "operationId": "get-internal-transactions-by-contract-address", "parameters": [ { "name": "contractAddress", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The address of contract (format: Base58 or Hex). Example: `TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs`" }, { "name": "only_confirmed", "in": "query", "description": "Set to `true` to return only confirmed transactions; set to `false` (or omit) to return both confirmed and unconfirmed. Cannot be used simultaneously with `only_unconfirmed`.", "schema": { "type": "boolean" } }, { "name": "only_unconfirmed", "in": "query", "description": "Set to `true` to return only unconfirmed transactions; set to `false` (or omit) to return both. Cannot be used simultaneously with `only_confirmed`.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "The maximum number of transactions to return per page. (Default: 20, Max: 200)", "schema": { "type": "integer", "format": "int32" } }, { "name": "fingerprint", "in": "query", "description": "The fingerprint for pagination, obtained from the `meta.fingerprint` field of a previous response. Note: When using `fingerprint`, all other parameters must remain the same.", "schema": { "type": "string" } }, { "name": "min_timestamp", "in": "query", "description": "The minimum block timestamp to filter by. (Unit: milliseconds, Default: 0)", "schema": { "type": "string", "format": "date" } }, { "name": "max_timestamp", "in": "query", "description": "The maximum block timestamp to filter by. (Unit: milliseconds, Default: current time)", "schema": { "type": "string", "format": "date" } }, { "name": "order_by", "in": "query", "description": "Sort order: `block_timestamp,asc` or `block_timestamp,desc` (default).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internal_tx_id": { "type": "string", "description": "The unique identifier (ID) for the internal transaction." }, "data": { "type": "object", "properties": { "note": { "type": "string", "description": "The type of instruction, such as `call`, `create`, `suicide`, `freezeBalanceV2ForEnergy`, `freezeBalanceV2ForBandwidth`, or `unfreezeBalanceV2ForBandwidth`." }, "rejected": { "type": "boolean", "description": "Whether the internal transaction failed during execution. `true` means the execution failed." }, "call_value": { "type": "array", "description": "Transfer amounts.", "items": { "type": "object", "properties": { "call_value": { "type": "integer", "format": "int64", "description": "Transfer amount. (Unit: sun)" }, "token_id": { "type": "string", "description": "Token ID. `_` denotes TRX (decimals 6); otherwise a TRC-10 token ID." } } } } } }, "block_timestamp": { "type": "integer", "format": "int64", "description": "The Unix timestamp for when the transaction was confirmed. (Unit: millisecond)" }, "to_address": { "type": "string", "description": "The recipient's address." }, "tx_id": { "type": "string", "description": "The unique identifier (ID) of the parent transaction that initiated this internal transaction." }, "from_address": { "type": "string", "description": "The sender's address. (Format: Hex, starts with `41`.)" } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The timestamp for when the API response was generated. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." }, "fingerprint": { "type": "string", "description": "A fingerprint of the last transaction on this page, used to fetch the next page of results." }, "links": { "type": "object", "properties": { "next": { "type": "string", "description": "The complete URL to request the next page of results. `null` if this is the last page." } } } } } } }, "examples": { "Result": { "value": "{}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } }, "/v1/trc20/info": { "get": { "description": "", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Contract address." }, "symbol": { "type": "string", "description": "Token symbol." }, "name": { "type": "string", "description": "Token name" }, "decimals": { "type": "string", "description": "Token decimals." }, "type": { "type": "string", "description": "Token type. (Fixed value: `trc20`)" }, "total_supply": { "type": "string", "description": "Token total supply." } } } }, "success": { "type": "boolean", "description": "Whether the request was successful." }, "meta": { "type": "object", "properties": { "at": { "type": "integer", "format": "int64", "description": "The response timestamp. (Unit: millisecond)" }, "page_size": { "type": "integer", "format": "int32", "description": "The number of items returned on the current page." } } } } }, "examples": { "Result": { "value": "{}" } } } } } }, "parameters": [ { "in": "query", "name": "contract_list", "schema": { "type": "string" }, "required": true, "description": "You can provide one or more contract addresses, with a maximum limit of 20. If providing multiple addresses, use a comma (,) as a delimiter. Example: `TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs,TVMZYcbjpjaGqmciUjzuRWzANTXfHxrRCs`" } ], "operationId": "get_v1-trc20-info" } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true }