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": string,
  "response": {
    "name": string,
    "symbol": string,
    "mintable": boolean,
    "freezeable": boolean,
    "total_supply": number,
    "lp_burn_percentage": number,
    "i_lp_percentage": number,
    "top_holders_percentage": number,
    "high_holders": {
      string: number,
      string: number,
    },
    "airdrop_percentage": number,
    "bundled_buy_percentage": number,
    "deployer": string,
    "dev_best_ath_usd": number,
    "dev_best_token": string,
    "dev_total_launches": number
  },
  "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.

  • 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/J4ywFdm8H7hjwKzCaEQujhkDRfCnRviVnHMvFNDAoLNQ"

Example Response

{
  "status": "OK",
  "response": {
    "name": "Soul Scanner",
    "symbol": "SOUL",
    "mintable": false,
    "freezeable": false,
    "total_supply": 999939.616324,
    "lp_burn_percentage": 100,
    "i_lp_percentage": 85,
    "top_holders_percentage": 7.59721897230893,
    "high_holders": {
      "BARTzTsoat5VyYd9fbNqVtN4UXk6dyFGszYzZd3xsiw3": 7.59721897230893
    },
    "airdrop_percentage": 0,
    "bundled_buy_percentage": 0,
    "deployer": "A5NkgVefjUedfAGTkn6pTpGCkCVkFzCiFqxmQZDD8aXk",
    "dev_best_ath": 326011.336500677,
    "dev_best_token": "J4ywFdm8H7hjwKzCaEQujhkDRfCnRviVnHMvFNDAoLNQ",
    "dev_total_launches": 1
  },
  "response_time": "71 ms"
}

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.

PreviousAPI V1

Last updated