Get Token List
1. Overview & Typical Use
Returns the full network token list, covering TRC10, TRC20, TRC721, TRC1155, and other types, with multi-dimensional sorting and filtering by market cap, price change, trading volume, and more.
- Typical use: token leaderboard display, market cap filtering, new token discovery.
- When not to use: for a single TRC20 token’s details use “Get TRC20/TRC721/TRC1155 Token Details”; for TRC10 details use “Get TRC10 Token Details”.
2. Endpoint & Authentication
GET /api/tokens/overview
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | integer | No | 0 | Start index (offset) |
limit | integer | No | 20 | Items per page, max 500 |
order | string | No | desc | Sort direction: desc (descending), asc (ascending) |
filter | string | No | all | Token type filter: trc10, trc20, trc721, trc1155, all, top |
sort | string | No | marketcap | Sort field: priceInTrx, gain, volume24hInTrx, holderCount, marketcap, createTime, hot, init, top |
field | string | No | — | Comma-separated field names to return; returns all fields when empty |
verifier | string | No | — | Set to all to include tokens with type=auto; not returned by default |
showAll | integer | No | 0 | Data type to return. 0: whitelist only, 1: all, 2: exclude blacklist |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
total | integer | Required | Total token count under current filter | — |
totalAll | integer | Required | Total token count including all types (same as totalAllCount) | — |
totalAllCount | integer | Required | Total tokens on the full network (all types) | — |
all | integer | Required | Total tokens on the full network (same as totalAllCount, kept for backward compatibility) | — |
total10 | integer | Required | Total TRC10 token count | — |
total20 | integer | Required | Total TRC20 token count | — |
total721 | integer | Required | Total TRC721 token count | — |
total1155 | integer | Required | Total TRC1155 token count | — |
currentWeekAll | integer | Required | New tokens this week (all types combined) | — |
currentWeekTotalAll | integer | Required | New tokens this week (another statistical measure) | — |
valueAtLeast | integer | Required | Minimum threshold for valued tokens (USD) | USD |
tokens | array | Required | Token list | — |
updateTime | integer | Required | Data update time | Millisecond timestamp |
tokens[] elements
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
name | string | Required | Token name | — |
abbr | string | Required | Token abbreviation | — |
contractAddress | string | Required | Contract address (_ for TRC10) | — |
tokenId | integer | Optional | TRC10 token ID (present for TRC10, absent for TRC20) | — |
ownerAddress | string | Optional | Issuer address (- for TRC10, actual address for TRC20) | — |
tokenType | string | Required | Token type (trc10 / trc20 / trc721 / trc1155) | — |
decimal | integer | Required | Decimal places | — |
priceInTrx | number | Optional | Price in TRX (only for priced tokens) | — |
priceInUsd | number | Optional | Price in USD (only for priced tokens) | — |
marketcap | number | Optional | Market cap (TRX, only for priced tokens) | TRX |
marketCapUSD | number | Optional | Market cap (USD, only for priced tokens) | USD |
gain | number | Optional | 24-hour price change (only for tokens with market data) | decimal |
volume24hInTrx | number | Optional | 24-hour trading volume (TRX, only for tokens with market data) | TRX |
volume24hInUsd | number | Optional | 24-hour trading volume (USD, only for tokens with market data) | USD |
supply | number | Optional | Circulating supply | — |
nrOfTokenHolders | integer | Required | Number of holders | — |
transferCount | integer | Required | Cumulative transfer count | — |
vip | boolean | Required | Whether this is a VIP token | — |
isTop | boolean | Optional | Whether this is a pinned token | — |
verifier | string | Optional | Verification source (e.g. "robot") | — |
level | string | Optional | Token level: 0 (UNKNOWN), 1 (NEUTRAL), 2 (OK), 3 (SUSPICIOUS), 4 (UNSAFE) | — |
canShow | integer | Optional | Whether to display (1 yes, 0 no) | — |
imgUrl | string | Optional | Token logo URL | — |
description | string | Optional | Token description | — |
github | string | Optional | GitHub link | — |
projectSite | string | Optional | Project website | — |
whitePaper | string | Optional | Whitepaper link | — |
socialMedia | string | Optional | Social media (JSON string) | — |
pairUrl | string | Optional | DEX trading pair URL | — |
dateCreated | integer | Optional | Creation timestamp | seconds timestamp |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
limitcap is 500: excess is silently truncated to 500, no error is returned.- Empty result is not an error: no matches returns
200+tokens: []— this is a normal response.
Last updated on: