SaturnX
  • WELCOME
    • ☀️What is Saturnx?
    • Pricing with Rate limits
      • Prepaid Credits
      • Pay with Crypto
  • RPC Nodes
    • RPCs Overview
  • BLOCKCHAIN
    • Overview
    • HTTP
      • getHistoryCandleStick
      • getHistoryTransaction
      • getAccountTnx
      • getAccountTnxByToken
      • getHoldersTop
      • getHotPairs
      • getTokenSecurity
    • WebSocket
      • {blockchain}.broadcast.transactions
      • {blockchain}.broadcast.kline
    • Kafka
Powered by GitBook
On this page
  1. BLOCKCHAIN
  2. HTTP

getTokenSecurity

This API provides a security analysis of a given token based on its address and blockchain. It assesses potential risks such as honeypot behavior, ownership concentration, metadata mutability

Example Request

Here’s an example of calling the API using curl:

curl -L \
  --request GET \
  --url "https://api.saturnx.dev/api/process/getTokenSecurity?apiKey=111&tokenAddress=GMk6j2defJhS7F194toqmJNFNhAkbDXhYJo5oR3Rpump&blockchain=solana" \
  --header "Content-Type: application/json"

Endpoint: /getTokenSecurity Method: GET Summary: Retrieve security assessment data for a specific token.

Name

Type

Required

Description

Example

apiKey

String

Yes

API Key for authentication

tokenAddress

String

Yes

Address of the token

GMk6j2defJhS7F194toqmJNFNhAkbDXhYJo5oR3Rpump

blockchain

String

Yes

Blockchain identifier

solana

Response

  • Status: 200 (Success)

  • Content Type: application/json

  • Structure:

json

{
  "code": 200,
  "message": "Operation Successful",
  "data": {
    "value": {
      "code": 1,
      "message": "ok",
      "result": {
        "GMk6j2defJhS7F194toqmJNFNhAkbDXhYJo5oR3Rpump": {
          "note": null,
          "lpTotalSupply": null,
          "lpHolders": null,
          "isAirdropScam": null,
          "metadataMutable": {
            "status": "0",
            "metadataUpgradeAuthority": []
          },
          "mintableAuthority": {
            "status": "0"
          },
          "otherPotentialRisks": null,
          "transferPausable": null,
          "tradingCooldown": null,
          "hiddenOwner": null,
          "selfdestruct": null,
          "ownerPercent": null,
          "isWhitelisted": null,
          "holderCount": null,
          "trustList": null,
          "isHoneypot": null,
          "honeypotWithSameCreator": null
        }
      }
    }
  }
}

Response Fields Explanation

Field

Type

Description

data.value

Object

Nested object containing the security assessment details.

data.value.code

Integer

Internal status code (1 indicates success).

data.value.message

String

Internal status message.

data.value.result

Object

Object containing the token-specific security analysis.

[tokenAddress]

Object

Token address as the key, mapping to its security assessment.

note

String

Additional notes or comments about the token (null if none).

lpTotalSupply

String

Total supply of liquidity pool tokens (null if not applicable or unavailable).

lpHolders

Integer

Number of liquidity pool holders (null if not applicable or unavailable).

isAirdropScam

Boolean

Indicates if the token is flagged as an airdrop scam (null if not assessed).

metadataMutable

Object

Metadata mutability status.

metadataMutable.status

String

"0" (immutable) or "1" (mutable).

metadataMutable.metadataUpgradeAuthority

Array

List of addresses with authority to modify metadata (empty if none).

mintableAuthority

Object

Minting authority status.

mintableAuthority.status

String

"0" (non-mintable) or "1" (mintable by authority).

otherPotentialRisks

String

Additional identified risks (null if none).

transferPausable

Boolean

Indicates if token transfers can be paused (null if not assessed).

tradingCooldown

String

Trading cooldown restrictions (null if not assessed).

hiddenOwner

Boolean

Indicates if ownership is obscured (null if not assessed).

selfdestruct

Boolean

Indicates if the contract can self-destruct (null if not assessed).

ownerPercent

Double

Percentage of tokens held by the owner (null if not calculated).

isWhitelisted

Boolean

Indicates if the token is on a trusted whitelist (null if not assessed).

holderCount

Integer

Number of token holders (null if not available).

trustList

Array

List of trusted entities (null if not applicable).

isHoneypot

Boolean

Indicates if the token is a honeypot (null if not assessed).

honeypotWithSameCreator

Boolean

Indicates if the creator has deployed other honeypot tokens (null if not assessed).

PreviousgetHotPairsNextWebSocket

Last updated 1 month ago