j5c5cneq.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 token 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 token 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": "Token addresses to filter by. If provided, only tokens with these addresses will be returned.",
      "in": "query",
      "name": "tokenAddresses",
      "required": false,
      "schema": {
        "description": "Token addresses to filter by. If provided, only tokens with these addresses will be returned.",
        "items": {
          "type": "string"
        },
        "maxItems": 50,
        "minItems": 1,
        "type": "array"
      }
    },
    {
      "description": "The number of tokens to return per chain (default: 20, max: 500).",
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 20,
        "description": "The number of tokens to return per chain (default: 20, max: 500).",
        "maximum": 1000,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "The page number for pagination (default: 1, max: 20).",
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 1,
        "description": "The page number for pagination (default: 1, max: 20).",
        "maximum": 500,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Whether to include token metadata (default: true).",
      "in": "query",
      "name": "metadata",
      "required": false,
      "schema": {
        "default": "true",
        "description": "Whether to include token metadata (default: true).",
        "enum": [
          "true",
          "false"
        ],
        "type": "string"
      }
    },
    {
      "description": "Whether to resolve metadata links to fetch additional token information (default: true).",
      "in": "query",
      "name": "resolveMetadataLinks",
      "required": false,
      "schema": {
        "default": "true",
        "description": "Whether to resolve metadata links to fetch additional token information (default: true).",
        "enum": [
          "true",
          "false"
        ],
        "type": "string"
      }
    },
    {
      "description": "Whether to include tokens marked as spam (default: false).",
      "in": "query",
      "name": "includeSpam",
      "required": false,
      "schema": {
        "default": "false",
        "description": "Whether to include tokens marked as spam (default: false).",
        "enum": [
          "true",
          "false"
        ],
        "type": "string"
      }
    },
    {
      "description": "Whether to include native tokens (e.g., ETH, MATIC) in the results (default: true).",
      "in": "query",
      "name": "includeNative",
      "required": false,
      "schema": {
        "default": "true",
        "description": "Whether to include native tokens (e.g., ETH, MATIC) in the results (default: true).",
        "enum": [
          "true",
          "false"
        ],
        "type": "string"
      }
    },
    {
      "description": "Field to sort tokens by: 'balance' for token balance, 'token_address' for token address, 'token_price' for token price, 'usd_value' for USD value (default: usd_value).",
      "in": "query",
      "name": "sortBy",
      "required": false,
      "schema": {
        "default": "usd_value",
        "description": "Field to sort tokens by: 'balance' for token balance, 'token_address' for token address, 'token_price' for token price, 'usd_value' for USD value (default: usd_value).",
        "enum": [
          "balance",
          "token_address",
          "token_price",
          "usd_value"
        ],
        "type": "string"
      }
    },
    {
      "description": "Sort order: 'asc' for ascending, 'desc' for descending (default: desc).",
      "in": "query",
      "name": "sortOrder",
      "required": false,
      "schema": {
        "default": "desc",
        "description": "Sort order: 'asc' for ascending, 'desc' for descending (default: desc).",
        "enum": [
          "asc",
          "desc"
        ],
        "type": "string"
      }
    },
    {
      "description": "Whether to include tokens without price data (default: true).",
      "in": "query",
      "name": "includeWithoutPrice",
      "required": false,
      "schema": {
        "default": "true",
        "description": "Whether to include tokens without price data (default: true).",
        "enum": [
          "true",
          "false"
        ],
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "result": {
                "properties": {
                  "pagination": {
                    "properties": {
                      "hasMore": {
                        "description": "Whether there are more items available",
                        "type": "boolean"
                      },
                      "limit": {
                        "default": 20,
                        "description": "Number of items per page",
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "page": {
                        "default": 1,
                        "description": "Current page number",
                        "type": [
                          "number",
                          "null"
                        ]
                      },
                      "totalCount": {
                        "description": "Total number of items available",
                        "type": [
                          "number",
                          "null"
                        ]
                      }
                    },
                    "type": "object"
                  },
                  "tokens": {
                    "description": "Array of wallet tokens.",
                    "items": {
                      "properties": {
                        "balance": {
                          "description": "The token balance as a string",
                          "type": "string"
                        },
                        "chain_id": {
                          "description": "The chain ID of the token",
                          "type": "number"
                        },
                        "decimals": {
                          "description": "The number of decimal places",
                          "type": "number"
                        },
                        "icon_uri": {
                          "description": "The token icon URI",
                          "type": "string"
                        },
                        "name": {
                          "description": "The token name",
                          "type": "string"
                        },
                        "price_data": {
                          "description": "Price data for the token",
                          "properties": {
                            "circulating_supply": {
                              "description": "The circulating supply of the token",
                              "type": "number"
                            },
                            "market_cap_usd": {
                              "description": "The market cap of the token in USD",
                              "type": "number"
                            },
                            "percent_change_24h": {
                              "description": "The percentage change of the token in the last 24 hours",
                              "type": "number"
                            },
                            "price_timestamp": {
                              "description": "The timestamp of the latest price update",
                              "type": "string"
                            },
                            "price_usd": {
                              "description": "The price of the token in USD",
                              "type": "number"
                            },
                            "total_supply": {
                              "description": "The total supply of the token",
                              "type": "number"
                            },
                            "usd_value": {
                              "description": "The value of the token balance in USD",
                              "type": "number"
                            },
                            "volume_24h_usd": {
                              "description": "The volume of the token in USD",
                              "type": "number"
                            }
                          },
                          "type": "object"
                        },
                        "prices": {
                          "additionalProperties": {
                            "type": "number"
                          },
                          "description": "Price data",
                          "type": "object"
                        },
                        "symbol": {
                          "description": "The token symbol",
                          "type": "string"
                        },
                        "token_address": {
                          "description": "The contract address of the token",
                          "type": "string"
                        }
                      },
                      "required": [
                        "balance",
                        "chain_id",
                        "token_address"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "required": [
                  "pagination",
                  "tokens"
                ],
                "type": "object"
              }
            },
            "required": [
              "result"
            ],
            "type": "object"
          }
        }
      },
      "description": "Wallet tokens retrieved successfully. Returns token data with metadata including pagination information and chain details. Includes token balances, metadata, and price information when available. Results are sorted by the specified criteria (default: USD value descending) and filtered according to the provided parameters."
    },
    "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 pagination parameters are out of range."
    },
    "401": {
      "description": "Authentication required. The request must include a valid `x-client-id` header for frontend usage or `x-secret-key` for backend usage."
    },
    "404": {
      "description": "Wallet not found or no tokens available for the specified wallet address on the given blockchain networks."
    },
    "500": {
      "description": "Internal server error. This may occur due to network connectivity issues, external service unavailability, or unexpected server errors."
    }
  }
}