Get Contract List
1. Overview & Typical Use
Returns a paginated list of on-chain smart contracts, supporting sorting by call count, balance, or creation time, and filtering by verification and open-source status.
- Typical use: contract leaderboard display, contract search, querying contracts by deployer.
- When not to use: to query a single contract’s details use “Get Contract Detail”; to query contract trigger transactions use “Get Trigger Transaction List”.
2. Endpoint & Authentication
GET /api/contracts
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | integer | No | 0 | Starting offset; start + limit ≤ 10000 |
limit | integer | No | 10 | Page size, max 50 |
sort | string | No | -trxCount | Sort field: -trxCount, -balance, -timestamp; - prefix means descending |
search | string | No | — | Search by contract name or address |
open-source-only | boolean | No | false | Show only open-source contracts |
verified-only | boolean | No | false | Show only verified contracts |
owner | string | No | — | Filter by deployer address |
start_timestamp | integer | No | — | Creation time start, ms timestamp |
end_timestamp | integer | No | — | Creation time end, ms timestamp |
confirm | integer | No | 0 | Confirmation status filter: 0 all, 1 confirmed |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
code | integer | Required | HTTP status code (200 on success) | — |
message | string | Required | Response message ("request ok" on success) | — |
total | integer | Required | Total hits (capped at 10000) | — |
rangeTotal | integer | Required | Total contracts matching the filter | — |
data | array | Required | Contract list | — |
triggerTop7 | array | Required | Top contracts by recent call volume (not strictly limited to 7) | — |
contractCount | integer | Required | Total contracts on the network | — |
contractCount24h | integer | Required | New contracts in the last 24 hours | — |
verifyContractCount | integer | Required | Total verified contracts | — |
verifyContractCount24h | integer | Required | New verified contracts in the last 24 hours | — |
totalTrigger | integer | Required | Total recent trigger transactions | — |
updateTime | integer | Required | Data update time | ms timestamp |
lastUpdateSeconds | integer | Required | Data last update time | s timestamp (10-digit) |
status | object | Required | Status code and message | — |
data[] element
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
address | string | Required | Contract address | — |
name | string | Required | Contract name | — |
verify_status | integer | Required | Verification status: 0 unverified, 1 partially verified, 2 fully verified | — |
balance | integer | Required | TRX balance | sun (1 TRX = 10^6 sun) |
trxCount | integer | Required | Cumulative transaction count | — |
date_created | integer | Required | Contract creation time | ms timestamp |
tag1 | string | Optional | Primary contract label | — |
tag1Url | string | Optional | Primary label link | — |
vip | boolean | Required | Whether it is a VIP contract | — |
risk | boolean | Required | Risk marker | — |
publicTagDesc | string | Required | Public label description (may be empty) | — |
license | string | Required | Open-source license identifier (e.g. "0" means none) | — |
compile_version | string | Optional | Compiler version (verified contracts) | — |
compile_settings | string | Required | Compilation settings JSON string; empty string "" for unverified contracts | — |
verify_time | integer | Required | Verification time; 0 for unverified contracts | ms timestamp |
trc20token | object | Optional | TRC20 token info (TRC20 contracts only) | — |
trc20token sub-fields
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
symbol | string | Required | Token symbol | — |
total_supply | string | Required | Total supply | — |
contract_address | string | Required | Contract address | — |
decimals | string | Required | Decimal places | — |
name | string | Required | Token name | — |
icon_url | string | Required | Token logo URL (may be empty) | — |
issuer_addr | string | Required | Issuer address | — |
holders_count | string | Required | Total holder count (string) | — |
token_type | string | Required | Token type (trc20 / trc721 / trc1155) | — |
level | string | Required | Token level | — |
token_desc | string | Optional | Token description | — |
home_page | string | Optional | Project home page URL | — |
git_hub | string | Optional | GitHub link | — |
white_paper | string | Optional | White paper link | — |
email | string | Optional | Contact email | — |
social_media | string | Optional | Social media link | — |
issue_time | string | Optional | Issue time | — |
status | string | Optional | Token status identifier | — |
triggerTop7[] element
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
contract | string | Required | Contract address | — |
name | string | Required | Contract name | — |
percentage | number | Required | Share of recent triggers | — |
triggers | integer | Required | Recent trigger count | — |
tag1 | string | Required | Contract label (may be empty) | — |
tag1Url | string | Required | Label link (may be empty) | — |
blueTagUrl | string | Required | Blue tag link (may be empty) | — |
risk | boolean | Required | Risk marker | — |
publicTagDesc | string | Required | Public label description (may be empty) | — |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
start + limitexceeds 10000: silently truncated and returns200; no error is raised.limitexceeds 50: silently capped at 50.- Empty result is not an error: returns
200+data: []when no matches are found.
Last updated on: