Skip to Content
APISecurity Service APICheck Token Security

Check Token Security

1. Overview & Typical Use

Returns security attributes for TRC10, TRC20, TRC721, or TRC1155 tokens, including VIP status, blacklist capability, supply control, token level, and liquidity.

  • Typical use: token risk assessment, pre-trade security check, token audit.
  • When not to use: to check account security use “Check Account Security”.

2. Endpoint & Authentication

GET /api/security/token/data

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

3. Request

ParameterTypeRequiredDefaultDescription
addressstringYesToken ID for TRC10, or contract address for TRC20/TRC721/TRC1155

4. Response

Top-level

FieldTypeRequiredDescriptionUnit/Precision
is_vipbooleanRequiredWhether this is a VIP token issued by a well-known institution
black_list_typeintegerRequiredBlacklist capability: 0 unrecognized, 1 has blacklist, 2 no blacklist
increase_total_supplyintegerRequiredWhether total supply can be increased: 0 unrecognized, 1 allowed, 2 not allowed
token_levelstringRequiredSecurity level: 0 unknown, 1 neutral, 2 normal, 3 suspicious, 4 unsafe
has_urlbooleanRequiredWhether the name or symbol contains a URL
swap_tokenbooleanRequiredWhether listed on sun.io
sun_liquiditystringOptionalLiquidityUSD
open_sourcebooleanRequiredWhether the contract is open source
is_proxybooleanRequiredWhether a proxy contract is used

5. Errors

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

  • When address is invalid, default values are returned without raising an error.
Last updated on: