TronGrid

TronGrid v3 (TG3) uses a set of NodeJS apps to talk with Redis and PostgreSQL to provide a simple, fast and reliable query interface for the Tron API.

For a reference to the legacy(v2) version please refer to this version of the README

Notes:

Versioning

TronGrid v3 (TG3) will use api versioning moving forward. As this is the first iteration of the improved TronGrid, we will start with v1. ex: https://api.trongrid.io/v1

Parameters, Queries, & Return Values

Addresses in TG3 can be passed in base58 or hex formats.
Query parameters can be passed in camelCase or snake_case.
All returned JSON properties will be in snake_case (at the first level at least)
NB: In this document, we will primarily use base58 and snake_case formats

APIs

Accounts

1. Get Account Info By Address

GET https://api.trongrid.io/v1/accounts/:address
JavaTron (JT) API:
- /wallet/getaccount
Usage:
- Returns information about a specific account
Params:
- address The account’s address in base58 or hex format (0x... and 41...)
Options:
- only_confirmed Shows only the situation at latest confirmed block. true | false default false
ex: https://api.trongrid.io/v1/accounts/TLCuBEirVzB6V4menLZKw1jfBTFMZbuKq7only_confirmed=false
Return example:

    {
      "success": true,
      "meta": {
        "at": 1558109062846,
        "page_size": 1
      },
      "data": [
        {
          "account_resource": {
            "energy_usage": 6027620,
            "frozen_balance_for_energy": {
              "expire_time": 1558164300000,
              "frozen_balance": 2116000000000
            },
            "latest_consume_time_for_energy": 1558108998000
          },
          "address": "41704833c02883b3261f7baf62f8cb19b4b0c2e64e",
          "allowance": 704953,
          "asset": [...],
          "assetV2": [...],
          "asset_issued_ID": "31303031343736",
          "asset_issued_name": "47616d65546f6b656e",
          "balance": 4196409173,
          "create_time": 1529897991000,
          "free_asset_net_usageV2": [...],
          "is_witness": true,
          "latest_consume_free_time": 1557905064000,
          "latest_opration_time": 1558108998000,
          "latest_withdraw_time": 1557905064000
        }
      ]
    }

2. Get Transactions By Account Address

GET https://api.trongrid.io/v1/accounts/:address/transactions
JavaTron (JT) API:
- /walletextension/gettransactionfromthis
- /walletextension/gettransactiontothis
Usage:
- Returns all the transactions related to a specified account.
Params: address The account’s address
Options:
- only_confirmed Shows only confirmed. true | false default false
- only_unconfirmed Shows only unconfirmed. true | false default false
- only_to Only transaction to address. true | false default false
- only_from Only transaction from address. true | false default false
- limit The requested number of transaction per page. Default 20. Max 200.
- fingerprint The fingerprint of the last transaction returned by the previous page
- order_by Pre sorts the results during the query. Example: order_by=block_number,asc order_by=block_timestamp,desc
- min_block_timestamp The minimum transaction timestamp default 0 Alias: min_timestamp
- max_block_timestamp The maximum transaction timestamp default now Alias: max_timestamp
ex: (N.B. Filter are non exclusives.)
- GET https://api.trongrid.io/v1/accounts/TLCuBEirVzB6V4menLZKw1jfBTFMZbuKq/transactions?only_to=true&only_from=true is equivalent to
- GET https://api.trongrid.io/v1/accounts/TLCuBEirVzB6V4menLZKw1jfBTFMZbuKq/transactions

3. Get Account Resources By Address

GET https://api.trongrid.io/v1/accounts/:address/resources
JavaTron (JT) API:
- /wallet/getaccountresource
Usage:
- Returns the resources associated to a specific account.
Params:
- address The account’s address
ex: https://api.trongrid.io/v1/accounts/TLCuBEirVzB6V4menLZKw1jfBTFMZbuKq/resources

    {
      "free_net_used": 4740,
      "free_net_limit": 5000,
      "asset_net_used": [...],
      "asset_net_limit": [...],
      "total_net_limit": 43200000000,
      "total_net_weight": 7001650727,
      "energy_used": 366327641,
      "energy_limit": 402999576,
      "total_energy_limit": 100000000000,
      "total_energy_weight": 496278437
    }

Assets

1. Get All Assets

GET https://api.trongrid.io/v1/assets
Usage:
- Returns all the assets.
Options:
- order_by Sorts the results. Accepted fields: total_supply,asc | total_supply,desc start_time,asc | start_time,desc end_time,asc | end_time,desc id,asc | id,desc
- Example: order_by=total_supply,asc

2. Get Assets By Identifier

GET https://api.trongrid.io/v1/assets/:identifier
JavaTron (JT) API:
- /wallet/getassetissuebyaccount
- /wallet/getassetissuebyid
Usage:
- Returns all the assets with the specified id or owner.
Params:
- identifier The identifier to be used to retrieve the asset It can be the ID of the asset, or the issuer address
Options:
- only_confirmed Shows only the situation at latest confirmed block. true | false default false

3. Get Assets By Name

GET https://api.trongrid.io/v1/assets/:name/list
JavaTron (JT) API:
- /wallet/getassetissuelistbyname
- /wallet/getassetissuelist
Usage:
- Returns all the assets with the specified name.
Params:
- name The name of the asset(s)
Options:
- limit The requested number of assets per page. Default 20. Max 200. When there is a pagination, the minimum limit is set to 20.
- fingerprint The fingerprint of the last asset returned by the previous page.
- order_by Pre sorts the results during the query.
  - Example: order_by=total_supply,asc (starts from the rarest token) order_by=start_time,desc (starts from the most recent ICO)
- only_confirmed Shows only the situation at latest confirmed block. true | false default false

Blocks

1. Returns Events By Block Identifier

GET https://api.trongrid.io/v1/blocks/:identifier/events
Usage:
- Returns all the events in the specified block. Depending on the data, the entire block can be confirmed or unconfirmed.
Params:
- identifier It can be either latest, a block number or a block id.

Contracts

1. Get Events By Contract Address

GET https://api.trongrid.io/v1/contracts/:address/events
Usage:
- Returns the events emitted by a smart contract.
Params:
- address The address of the deployed contract.
Options:
- only_confirmed Shows only confirmed. true | false default false
- only_unconfirmed Shows only unconfirmed. true | false default false
- event_name The name of the event
- block_number The block number for which the events are required
- min_block_timestamp The minimum block timestamp default 0 Alias: min_timestamp
- max_block_timestamp The maximum block timestamp default now Alias: max_timestamp
- limit For pagination. Limit 20
- fingerprint The fingerprint of last event retrieved in the page
- order_by Sort the events.
  - Accepted values: block_timestamp,asc (alias: timestamp,asc) block_timestamp,desc (default)

2. Get Transactions By Contract Address

GET https://api.trongrid.io/v1/contracts/:address/transactions
Usage:
- Returns the transactions related a smart contract.
Params:
- address The address of the deployed contract.
Options:
- only_confirmed Shows only confirmed. true | false default false
- only_unconfirmed Shows only unconfirmed. true | false default false
- min_block_timestamp The minimum block timestamp default 0 Alias: min_timestamp
- max_block_timestamp The maximum block timestamp default now Alias: max_timestamp
- limit For pagination. Limit 20
- fingerprint The fingerprint of last event retrieved in the page
- order_by Sort the events.
  - Accepted values: block_timestamp,asc (alias: timestamp,asc) block_timestamp,desc (default)

Transactions

1. Get Events By Transaction ID

GET https://api.trongrid.io/v1/transactions/:id/events
Usage:
- Returns the events emitted by a transaction.
Params:
- id The id of the transaction

------

TronWeb compatibility

To keep compatibility with TronWeb, TronGrid supports also the legacy format.
The Following are Four Methods for Polling:

1. By Contract Address:<br>

https://api.trongrid.io/event/contract/TEEXEWrkMFKapSMJ6mErg39ELFKDqEs6w3

2. By Contract Address and Event Name:<br>

curl https://api.trongrid.io/event/contract/TEEXEWrkMFKapSMJ6mErg39ELFKDqEs6w3/DiceResult

3. By Contract Address, Event Name, and Block Height:

https://api.trongrid.io/event/contract/TEEXEWrkMFKapSMJ6mErg39ELFKDqEs6w3/DiceResult/7273383

4. By Transaction ID:<br>

https://api.trongrid.io/event/transaction/d74ba9c3947b509db385fe2df5fb1dc49f10fb33da93e1e5903d897714ef0f5c

Request Parameters:<br>

fromTimestamp sets a time stamp, default 0, returning all events after or before that timestamp. For example:

https://api.trongrid.io/event/contract/TEEXEWrkMFKapSMJ6mErg39ELFKDqEs6w3?fromTimestamp=1541547888000

For retro-compatibility you can pass since instead of fromTimestamp.

size indicates the number of results returned. Default is 20, maximum is 200. Example:

https://api.trongrid.io/event/contract/TMJnJcHfdP5rhmXVkwRYb1a9A6gS46PUm6/Notif

Trongrid

Install / Use

README