zkbcy7ja.nx.link

{
  "parameters": [
    {
      "description": "Public key of the Solana wallet.",
      "in": "path",
      "name": "address",
      "required": true,
      "schema": {
        "description": "Public key of the Solana wallet.",
        "example": "8JBLmveV4YF5AQ7EVnKJgyj6etGgVkPp3tYqQMTu3p5B",
        "pattern": "^[1-9A-HJ-NP-Za-km-z]{32,44}$",
        "type": "string"
      }
    },
    {
      "description": "Solana network to query. Choose either solana:mainnet or solana:devnet.",
      "in": "query",
      "name": "chainId",
      "required": true,
      "schema": {
        "anyOf": [
          {
            "examples": [
              "eip155:1",
              "eip155:137",
              "eip155:8453",
              "solana:mainnet",
              "solana:devnet",
              "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
              "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1"
            ],
            "pattern": "^[a-z0-9]{3,8}:[-_A-Za-z0-9]{1,32}$",
            "type": "string"
          },
          {
            "examples": [
              1,
              137,
              8453
            ],
            "minimum": 1,
            "type": "integer"
          }
        ],
        "description": "Solana network to query. Choose either solana:mainnet or solana:devnet.",
        "examples": [
          "solana:mainnet",
          "solana:devnet"
        ],
        "type": "string"
      }
    },
    {
      "description": "SPL token mint address. Omit to retrieve native SOL balance.",
      "in": "query",
      "name": "tokenAddress",
      "required": false,
      "schema": {
        "description": "SPL token mint address. Omit to retrieve native SOL balance.",
        "example": "8JBLmveV4YF5AQ7EVnKJgyj6etGgVkPp3tYqQMTu3p5B",
        "pattern": "^[1-9A-HJ-NP-Za-km-z]{32,44}$",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "result": {
                "description": "Balance data for the requested Solana network.",
                "properties": {
                  "chainId": {
                    "anyOf": [
                      {
                        "examples": [
                          "eip155:1",
                          "eip155:137",
                          "eip155:8453",
                          "solana:mainnet",
                          "solana:devnet",
                          "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
                          "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1"
                        ],
                        "pattern": "^[a-z0-9]{3,8}:[-_A-Za-z0-9]{1,32}$",
                        "type": "string"
                      },
                      {
                        "examples": [
                          1,
                          137,
                          8453
                        ],
                        "minimum": 1,
                        "type": "integer"
                      }
                    ],
                    "description": "Requested Solana network.",
                    "examples": [
                      "solana:mainnet",
                      "solana:devnet"
                    ],
                    "type": "string"
                  },
                  "decimals": {
                    "description": "Number of decimals used by the token.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "displayValue": {
                    "description": "Human-readable balance formatted using token decimals.",
                    "type": "string"
                  },
                  "value": {
                    "description": "Raw balance value expressed in base units (lamports).",
                    "type": "string"
                  }
                },
                "required": [
                  "chainId",
                  "decimals",
                  "displayValue",
                  "value"
                ],
                "type": "object"
              }
            },
            "required": [
              "result"
            ],
            "type": "object"
          }
        }
      },
      "description": "Wallet balance retrieved successfully for the requested Solana network."
    },
    "400": {
      "description": "Invalid request parameters. This occurs when the wallet address or token mint is invalid, or the request mixes a token mint with multiple networks."
    },
    "401": {
      "description": "Authentication required. Include `x-client-id` or `x-secret-key` headers."
    },
    "500": {
      "description": "Internal server error. This may occur due to RPC connectivity issues or unexpected failures."
    }
  }
}