Skip to Content
APIContractGet Contract Detail

Get Contract Detail

1. Overview & Typical Use

Returns complete detailed information for a contract by address, including verification status, creator, method signature map, label info, and token info.

  • Typical use: contract detail page rendering, contract security audit lookup, method signature reverse lookup.
  • When not to use: to query a list of contracts use “Get Contract List”; to query contract call statistics use “Get Contract Call Statistics”.

2. Endpoint & Authentication

GET /api/contract

For Base URL and authentication, see Common Network & Authentication.

3. Request

ParameterTypeRequiredDefaultDescription
contractstringYesContract address (Base58, starts with T)
sourcestringNoData source identifier
session-idstringNoSession ID
wordstringNoKeyword search
typestringNoContract type filter
addressstringNoFilter by issuer address
directionstringNoFilter direction
issueNamestringNoTRC10 issuer address or name
orderintegerNo-1Sort direction: 1 ascending / -1 descending

4. Response

Top-level

FieldTypeRequiredDescriptionUnit/Precision
typestringRequiredResponse type
countintegerRequiredNumber of records returned; this field always returns 0 on this detail endpoint regardless of data[] length — use array length instead
statusobjectRequiredStatus code and message
dataarrayRequiredArray of contract data

data[] element

FieldTypeRequiredDescriptionUnit/Precision
addressstringRequiredContract address
balanceintegerRequiredTRX balancesun (1 TRX = 10^6 sun)
balanceInUsdnumberRequiredTRX balance in USD
verify_statusintegerRequiredVerification status: 0 unverified, 1 partially verified, 2 fully verified
is_proxybooleanRequiredWhether it is a proxy contract
proxy_implementationstringRequiredImplementation address of the proxy contract (empty string if not a proxy)
old_proxy_implementationstringRequiredOld proxy implementation address (empty string if not a proxy)
trxCountintegerRequiredCumulative transaction count
date_createdintegerRequiredCreation timems timestamp
call_valueintegerRequiredTRX value attached at contract creationsun
call_token_valueintegerRequiredTRC10 token value attached at contract creation
call_token_idintegerRequiredTRC10 token ID attached at contract creation
call_token_infoobjectRequiredDetailed info of the token attached at creation; object containing a tokenInfo key — inner schema see call_token_info.tokenInfo sub-table below
namestringRequiredContract name
descriptionstringRequiredContract description (may be empty)
tag1stringOptionalPrimary contract label
tag1UrlstringOptionalPrimary label link
vipbooleanRequiredWhether it is a VIP contract
feedbackRiskbooleanRequiredWhether there is a risk feedback
announcementstringRequiredAnnouncement content (may be empty)
licensestringRequiredOpen-source license identifier (e.g. "0" means none)
blueTagstringOptionalBlue tag (official verification label)
blueTagUrlstringOptionalBlue tag link
greyTagstringRequiredGrey tag (may be empty)
redTagstringRequiredRed tag (risk marker, may be empty)
publicTagstringOptionalPublic label
publicTagDescstringRequiredPublic label description (may be empty)
activeDayintegerRequiredNumber of active daysdays
creatorobjectRequiredCreator info (see sub-table)
auditReportUrlstringRequiredAudit report URL (may be empty)
auditDepstringRequiredAuditing organization (may be empty)
auditDatestringRequiredAudit date (may be empty)
destroyedintegerOptionalReturned only for destroyed contracts; value is fixed at 1 (destruction marker — note the type is integer, not boolean; under strict typing 1 === true does not hold); active contracts omit this field. Evidence: TCySpKjSp8SGW7g6eVnzVYtbY2WeC5MBZF returns destroyed: 1
destroyed_hashstringOptionalDestruction transaction hash; paired with destroyed, returned only for destroyed contracts; omitted for active contracts
methodMapobjectRequiredMethod selector → method signature map
energy_factornumberRequiredEnergy factor
tokenInfoobjectRequiredToken metadata (value schema below); non-token contracts also return this object, with contents reflecting the contract’s owning token (e.g. TRX placeholder)
balanceWithTokensnumberRequiredTotal balance including token assetsTRX
balanceWithTokensInUsdnumberRequiredTotal balance including token assets in USDUSD

call_token_info.tokenInfo object schema (9 common fields):

FieldTypeRequiredDescriptionUnit/Precision
tokenIdstringRequiredToken contract address (Base58); TRX placeholder is _
tokenAbbrstringRequiredToken abbreviation (e.g. USDT / TRX)
tokenNamestringRequiredToken name
tokenDecimalintegerRequiredDecimal precision (required to convert the amount field)
tokenCanShowintegerRequiredWhether displayable (1 yes / 0 no)
tokenTypestringRequiredToken type (trc10 / trc20 / trc721 / trc1155)
tokenLogostringRequiredToken logo URL
tokenLevelstringRequiredToken level
vipbooleanRequiredWhether it is a VIP token

tokenInfo object schema (9 common fields + issuerAddr):

FieldTypeRequiredDescriptionUnit/Precision
tokenIdstringRequiredToken contract address (Base58); TRX placeholder is _
tokenAbbrstringRequiredToken abbreviation (e.g. USDT / TRX)
tokenNamestringRequiredToken name
tokenDecimalintegerRequiredDecimal precision (required to convert the amount field)
tokenCanShowintegerRequiredWhether displayable (1 yes / 0 no)
tokenTypestringRequiredToken type (trc10 / trc20 / trc721 / trc1155)
tokenLogostringRequiredToken logo URL
tokenLevelstringRequiredToken level
vipbooleanRequiredWhether it is a VIP token
issuerAddrstringRequiredIssuer address (Base58)

creator object

FieldTypeRequiredDescriptionUnit/Precision
addressstringRequiredCreator address
address_is_contractbooleanRequiredWhether the creator is a contract
txHashstringRequiredCreation transaction hash
token_balanceintegerRequiredCreator token balance
consume_user_resource_percentintegerRequiredUser resource consumption percentage%
energy_remainingintegerRequiredRemaining energy
energy_limitintegerRequiredEnergy limit
energy_rationumberRequiredEnergy ratio

5. Errors

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

  • Contract address does not exist: returns 200 + data: [], count: 0; no 4xx is raised.
  • Empty result is not an error: when the address is invalid or the contract does not exist, an empty array is returned as a normal response.
Last updated on: