yddkctoq.nx.link

{
  "parameters": [
    {
      "description": "A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth).",
      "in": "path",
      "name": "address",
      "required": true,
      "schema": {
        "description": "A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth).",
        "type": "string"
      }
    },
    {
      "description": "Chain ID(s) to request balance data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137",
      "in": "query",
      "name": "chainId",
      "required": true,
      "schema": {
        "description": "Chain ID(s) to request balance data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137",
        "items": {
          "type": "integer"
        },
        "maxItems": 50,
        "minItems": 1,
        "type": "array"
      }
    },
    {
      "description": "The token contract address. Omit for native token (ETH, MATIC, etc.).",
      "in": "query",
      "name": "tokenAddress",
      "required": false,
      "schema": {
        "description": "The token contract address. Omit for native token (ETH, MATIC, etc.).",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "result": {
                "items": {
                  "properties": {
                    "chainId": {
                      "description": "The blockchain network ID",
                      "type": "number"
                    },
                    "decimals": {
                      "description": "Number of decimal places for the token",
                      "type": "number"
                    },
                    "displayValue": {
                      "description": "Human-readable balance formatted with appropriate decimal places",
                      "type": "string"
                    },
                    "name": {
                      "description": "The token name (e.g., 'Ether', 'USD Coin')",
                      "type": "string"
                    },
                    "symbol": {
                      "description": "The token symbol (e.g., 'ETH', 'USDC')",
                      "type": "string"
                    },
                    "tokenAddress": {
                      "description": "The token contract address. Returns zero address (0x0...0) for native tokens.",
                      "type": "string"
                    },
                    "value": {
                      "description": "Raw balance value as string in smallest unit (wei for ETH, etc.)",
                      "type": "string"
                    }
                  },
                  "required": [
                    "chainId",
                    "decimals",
                    "displayValue",
                    "name",
                    "symbol",
                    "tokenAddress",
                    "value"
                  ],
                  "type": "object"
                },
                "type": "array"
              }
            },
            "required": [
              "result"
            ],
            "type": "object"
          }
        }
      },
      "description": "Wallet native balances retrieved successfully. Returns detailed native token balance information for each chain including token metadata and formatted values."
    },
    "400": {
      "description": "Invalid request parameters. This occurs when the wallet address format is invalid, chainId array is empty or exceeds the maximum limit of 50, or chain IDs are invalid."
    },
    "401": {
      "description": "Authentication required. The request must include a valid `x-client-id` header for frontend usage or `x-secret-key` for backend usage."
    },
    "500": {
      "description": "Internal server error. This may occur due to blockchain connectivity issues, RPC service unavailability, or unexpected server errors."
    }
  }
}