/goplus/nft-security

POST /api/goplus/nft-security

Price: 1 credit

Run an NFT collection security check by chain and contract address

How to use it

Run a security check on an NFT collection by its chain and contract address. Returns collection identity (name, symbol, description, ERC standard, creator, creation block, item and owner counts), verification, open-source and proxy status, malicious-contract / metadata-frozen / oversupply-minting / restricted-approval / red-check-mark / trust-list flags, privileged-operation owners (self-destruct, transfer without approval, privileged mint and burn), 24h market stats (volume, sales, high/low/avg price), social links, and similar (possibly counterfeit) collections.

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: "GoplusNft")
• address string required
• name string nullable
• symbol string nullable
• description string nullable
• erc_type string nullable
• creator_address string nullable
• create_block_number integer nullable
• item_count integer nullable
• owner_count integer nullable
• is_verified boolean nullable
• is_open_source boolean nullable
• is_proxy boolean nullable
• is_malicious_contract boolean nullable
• is_metadata_frozen boolean nullable
• oversupply_minting boolean nullable
• restricted_approval boolean nullable
• red_check_mark boolean nullable
• trust_list boolean nullable
• token_owner string nullable
• token_id string nullable
• self_destruct object nullable
  • @type string (default: "GoplusNftPrivilege")
  • address string nullable
  • type string nullable
  • value integer nullable
• transfer_without_approval object nullable
  • @type string (default: "GoplusNftPrivilege")
  • address string nullable
  • type string nullable
  • value integer nullable
• privileged_minting object nullable
  • @type string (default: "GoplusNftPrivilege")
  • address string nullable
  • type string nullable
  • value integer nullable
• privileged_burn object nullable
  • @type string (default: "GoplusNftPrivilege")
  • address string nullable
  • type string nullable
  • value integer nullable
• total_volume number nullable
• traded_volume_24h number nullable
• sales_24h integer nullable
• highest_price number nullable
• lowest_price_24h number nullable
• average_price_24h number nullable
• website_url string nullable
• discord_url string nullable
• twitter_url string nullable
• telegram_url string nullable
• github_url string nullable
• medium_url string nullable
• same_nfts array (default: [])
  • @type string (default: "GoplusSameNft")
  • address string required
  • name string nullable
  • symbol string nullable
  • owner_count integer nullable
  • create_block_number integer nullable

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 — NFT collection 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.