Security Endpoint

Overview

This document describes the API endpoint GET https://api.soulscanner.xyz/security/, which provides detailed information about the security and characteristics of a specific token, identified by the unique token address.

Endpoint

• URL: https://api.soulscanner.xyz/security/:address

• Method: GET

• Response Format: JSON

Response Structure

The API returns a JSON object with the following structure:

{
  "status": "OK",
  "response": {
    "name": "string",
    "symbol": "string",
    "mintable": boolean,
    "freezeable": boolean,
    "total_supply": number,
    "lp_burn_percentage": number | null,
    "i_lp_percentage": number | null,
    "top_holders_percentage": number,
    "high_holders": { "walletAddress": number },
    "airdrop_percentage": number | null,
    "bundled_buy_percentage": number | null,
    "bundles_count": number | null,
    "bundles_token_percentage": number | null,
    "bundles_holding_percentage": number | null,
    "bundles_unique_wallets": number | null,
    "bundles_sol_spent": number | null,
    "deployer": "string | null",
    "dev_best_ath_usd": number | null,
    "dev_best_token": "string | null",
    "dev_total_launches": number | null
  },
  "response_time": "string"
}

Fields

• name: string

  • The name of the token, in this case, "Soul Scanner".

• symbol: string

  • The ticker symbol of the token, e.g., "SOUL".

• mintable: boolean

  • Indicates if the token can be minted (created) after its initial issuance. false means no additional tokens can be minted.

• freezable: boolean

  • Indicates if the token can be frozen by its creator or a designated authority. false means token accounts cannot be frozen.

• total_supply: number

  • The total supply of the token currently in circulation in decimal formatted value.

• lp_burn_percentage: number

  • The percentage of liquidity pool (LP) tokens that have been burned.

• i_lp_percentage: number

  • The percentage of supply used in the initial liquidity pool.

• top_holders_percentage: number

  • The percentage of tokens held by the top holders.

• high_holders: object

  • A key-value pair indicating the wallet address and the percentage of total supply held by each.

• airdrop_percentage: number

  • The percentage of tokens that were distributed via airdrops.

• bundled_buy_percentage: number

  • The percentage of tokens that were purchased via bundled buys.

• bundles_token_percentage: number

  • Percent of total supply purchased through bundles.

• bundles_holding_percentage: number

  • Percent of total supply still held by bundle wallets.

• bundles_unique_wallets:number

  • Unique wallets that participated in bundles.

• bundles_sol_spent:number

  • Total SOL spent across all bundles.

• deployer: string

  • The wallet address of the token deployer.

• dev_best_ath_usd: number

  • The best All-Time High (ATH) reached by a token associated with this developer.

• dev_best_token: string

  • The token address of the developer's best-performing token.

• dev_total_launches: number

  • The total number of token launches by this developer.

Example Request

curl -X GET "https://api.soulscanner.xyz/security/eoWox2uTvPYBkNXMffxs6G3pCTXY9Ypzu1dmMKypump"

Example Response

{
    "status": "OK",
    "response": {
        "name": "Penny",
        "symbol": "PENNY",
        "mintable": false,
        "freezeable": false,
        "total_supply": 999999999.999999,
        "lp_burn_percentage": 100,
        "i_lp_percentage": 100,
        "top_holders_percentage": 68.38529356288817,
        "high_holders": {
            "HM7ty6K28ypp7air4Z6AskYcLPB8FZzmUbpKuu5KRVyM": 20.93450186200232,
            "9xrCSUDcFHXek9TmrhmnxeETvBvetqqHkjxmxxy91bdz": 12.93643843856271,
            "4VHkoLUCT77HuFYQzfhGKTPsA4iagpsnvP9yUtPoFU8R": 9.36258002324251,
            "D9LN9mudc1eJoP8ozGmmo6W4hJ18ASN42NNWrFMZubzY": 6.565505910427906,
            "9x83Bfgj28eNHVUyjU5mdYRhqQPFmr6rLNyntCKqqFtu": 6.4330687790027055,
            "A3RiZcqKUeVKaJ3WxKdGy2ZCMashZVex2krCFrVKDhHL": 6.205119390916006,
            "5zWcaTCn51ag6A69nJWRgQrhLmNSkmuQ5z8thiS4QySU": 5.948079158734005
        },
        "airdrop_percentage": 0,
        "bundled_buy_percentage": 79.31,
        "deployer": "2ioraLk5XaFk9haznj325XtDyAKXSafsvN1NokLCibzg",
        "dev_best_ath_usd": 181251.6609028406,
        "dev_best_token": "eoWox2uTvPYBkNXMffxs6G3pCTXY9Ypzu1dmMKypump",
        "dev_total_launches": 1,
        "bundles_count": 1,
        "bundles_token_percentage": 79.31,
        "bundles_holding_percentage": 79.31,
        "bundles_unique_wallets": 7,
        "bundles_sol_spent": 85.00535906100001
    }
}

Supported Dexes

• Ray AMM

• RAY CPMM

• PUMPFUN

• PUMPSWAP

• MOONIT

• RAY LAUNCHLAB

Error Handling

If the request fails, the API will return an appropriate HTTP status code and an error message in the status field, such as "status": "NO TOKEN FOUND" with additional details about the error.