Skip to Content
APIContractGet Contract List

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

ParameterTypeRequiredDefaultDescription
startintegerNo0Starting offset; start + limit ≤ 10000
limitintegerNo10Page size, max 50
sortstringNo-trxCountSort field: -trxCount, -balance, -timestamp; - prefix means descending
searchstringNo—Search by contract name or address
open-source-onlybooleanNofalseShow only open-source contracts
verified-onlybooleanNofalseShow only verified contracts
ownerstringNo—Filter by deployer address
start_timestampintegerNo—Creation time start, ms timestamp
end_timestampintegerNo—Creation time end, ms timestamp
confirmintegerNo0Confirmation status filter: 0 all, 1 confirmed

4. Response

Top-level

FieldTypeRequiredDescriptionUnit/Precision
codeintegerRequiredHTTP status code (200 on success)—
messagestringRequiredResponse message ("request ok" on success)—
totalintegerRequiredTotal hits (capped at 10000)—
rangeTotalintegerRequiredTotal contracts matching the filter—
dataarrayRequiredContract list—
triggerTop7arrayRequiredTop contracts by recent call volume (not strictly limited to 7)—
contractCountintegerRequiredTotal contracts on the network—
contractCount24hintegerRequiredNew contracts in the last 24 hours—
verifyContractCountintegerRequiredTotal verified contracts—
verifyContractCount24hintegerRequiredNew verified contracts in the last 24 hours—
totalTriggerintegerRequiredTotal recent trigger transactions—
updateTimeintegerRequiredData update timems timestamp
lastUpdateSecondsintegerRequiredData last update times timestamp (10-digit)
statusobjectRequiredStatus code and message—

data[] element

FieldTypeRequiredDescriptionUnit/Precision
addressstringRequiredContract address—
namestringRequiredContract name—
verify_statusintegerRequiredVerification status: 0 unverified, 1 partially verified, 2 fully verified—
balanceintegerRequiredTRX balancesun (1 TRX = 10^6 sun)
trxCountintegerRequiredCumulative transaction count—
date_createdintegerRequiredContract creation timems timestamp
tag1stringOptionalPrimary contract label—
tag1UrlstringOptionalPrimary label link—
vipbooleanRequiredWhether it is a VIP contract—
riskbooleanRequiredRisk marker—
publicTagDescstringRequiredPublic label description (may be empty)—
licensestringRequiredOpen-source license identifier (e.g. "0" means none)—
compile_versionstringOptionalCompiler version (verified contracts)—
compile_settingsstringRequiredCompilation settings JSON string; empty string "" for unverified contracts—
verify_timeintegerRequiredVerification time; 0 for unverified contractsms timestamp
trc20tokenobjectOptionalTRC20 token info (TRC20 contracts only)—

trc20token sub-fields

FieldTypeRequiredDescriptionUnit/Precision
symbolstringRequiredToken symbol—
total_supplystringRequiredTotal supply—
contract_addressstringRequiredContract address—
decimalsstringRequiredDecimal places—
namestringRequiredToken name—
icon_urlstringRequiredToken logo URL (may be empty)—
issuer_addrstringRequiredIssuer address—
holders_countstringRequiredTotal holder count (string)—
token_typestringRequiredToken type (trc20 / trc721 / trc1155)—
levelstringRequiredToken level: 0 (UNKNOWN), 1 (NEUTRAL), 2 (OK), 3 (SUSPICIOUS), 4 (UNSAFE)—
token_descstringOptionalToken description—
home_pagestringOptionalProject home page URL—
git_hubstringOptionalGitHub link—
white_paperstringOptionalWhite paper link—
emailstringOptionalContact email—
social_mediastringOptionalSocial media link—
issue_timestringOptionalIssue time—
statusstringOptionalToken status identifier—

triggerTop7[] element

FieldTypeRequiredDescriptionUnit/Precision
contractstringRequiredContract address—
namestringRequiredContract name—
percentagenumberRequiredShare of recent triggers—
triggersintegerRequiredRecent trigger count—
tag1stringRequiredContract label (may be empty)—
tag1UrlstringRequiredLabel link (may be empty)—
blueTagUrlstringRequiredBlue tag link (may be empty)—
riskbooleanRequiredRisk marker—
publicTagDescstringRequiredPublic label description (may be empty)—

5. Errors

For HTTP status codes, see Common Errors. Key points for this endpoint:

  • start + limit exceeds 10000: silently truncated and returns 200; no error is raised.
  • limit exceeds 50: silently capped at 50.
  • Empty result is not an error: returns 200 + data: [] when no matches are found.
Last updated on: