/goplus/token-security

POST /api/goplus/token-security

Price: 1 credit

Run a token security / honeypot check by chain and contract address

How to use it

Run a security and honeypot audit on an ERC-20 / BEP-20 (or Tron) token by its chain and contract address. Returns whether the token is a honeypot, can be bought/sold, buy/sell/transfer taxes, owner and creator privileges (mint, blacklist, whitelist, take-back-ownership, hidden owner, self-destruct, pausable transfers, slippage/anti-whale modifiable), open-source and proxy status, trust-list flag, holder and LP-holder counts and top holders, DEX liquidity pools, and whether it is listed on known exchanges. Some low-risk fields are omitted by the source for trusted tokens.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• chain_id string required — Blockchain network the contract is deployed on (one of: "1", "10", "25", "56", "100", "130", "137", "146", "169", "177", "196", "204", "321", "324", "480", "1868", "1625", "1514", "1030", "2818", "2741", "4200", "5000", "8453", "59144", "43114", "42766", "42161", "81457", "80094", "200901", "201022", "534352", "48900", "688688", "810180", "tron")
• contract_address string required — Token / contract address on the selected chain (examples: "0x6982508145454ce325ddbe47a25d4ec3d2311933"; minLength: 1)

Response

• @type string (default: "GoplusToken")
• address string required
• name string nullable
• symbol string nullable
• total_supply number nullable
• holder_count integer nullable
• trust_list boolean nullable
• is_open_source boolean nullable
• is_proxy boolean nullable
• is_mintable boolean nullable
• is_honeypot boolean nullable
• honeypot_with_same_creator boolean nullable
• cannot_buy boolean nullable
• cannot_sell_all boolean nullable
• buy_tax number nullable
• sell_tax number nullable
• transfer_tax number nullable
• is_blacklisted boolean nullable
• is_whitelisted boolean nullable
• is_anti_whale boolean nullable
• anti_whale_modifiable boolean nullable
• can_take_back_ownership boolean nullable
• hidden_owner boolean nullable
• selfdestruct boolean nullable
• external_call boolean nullable
• gas_abuse boolean nullable
• slippage_modifiable boolean nullable
• personal_slippage_modifiable boolean nullable
• trading_cooldown boolean nullable
• transfer_pausable boolean nullable
• owner_change_balance boolean nullable
• fake_token boolean nullable
• is_true_token boolean nullable
• is_airdrop_scam boolean nullable
• is_in_dex boolean nullable
• note string nullable
• other_potential_risks string nullable
• creator_address string nullable
• creator_balance number nullable
• creator_percent number nullable
• owner_address string nullable
• owner_balance number nullable
• owner_percent number nullable
• lp_holder_count integer nullable
• lp_total_supply number nullable
• holders array (default: [])
  • @type string (default: "GoplusTokenHolder")
  • address string required
  • tag string nullable
  • is_contract boolean nullable
  • balance number nullable
  • percent number nullable
  • value number nullable
  • is_locked boolean nullable
  • nft_list array (default: [])
    • @type string (default: "GoplusLpNft")
    • nft_id string nullable
    • value number nullable
    • amount number nullable
    • percent number nullable
    • in_effect boolean nullable
• lp_holders array (default: [])
  • @type string (default: "GoplusTokenHolder")
  • address string required
  • tag string nullable
  • is_contract boolean nullable
  • balance number nullable
  • percent number nullable
  • value number nullable
  • is_locked boolean nullable
  • nft_list array (default: [])
    • @type string (default: "GoplusLpNft")
    • nft_id string nullable
    • value number nullable
    • amount number nullable
    • percent number nullable
    • in_effect boolean nullable
• dex array (default: [])
  • @type string (default: "GoplusTokenDex")
  • name string nullable
  • liquidity_type string nullable
  • liquidity number nullable
  • pair string nullable
  • pool_fee number nullable
  • pool_manager string nullable
• is_in_cex object nullable
  • @type string (default: "GoplusTokenCex")
  • is_listed boolean nullable
  • cex_list array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Token not found or not analyzed on this chain Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.