yddkctoq.nx.link

{
  "parameters": [
    {
      "description": "Number of tokens to return per page (1-100).",
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 20,
        "description": "Number of tokens to return per page (1-100).",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Page number for pagination, starting from 1.",
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 1,
        "description": "Page number for pagination, starting from 1.",
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Limit tokens to a specific chain.",
      "in": "query",
      "name": "chainId",
      "required": false,
      "schema": {
        "description": "Limit tokens to a specific chain.",
        "examples": [
          1,
          8453,
          137,
          56,
          43114,
          42161,
          10
        ],
        "exclusiveMinimum": true,
        "minimum": 0,
        "type": "integer"
      }
    },
    {
      "description": "Get a specific token by contract address",
      "in": "query",
      "name": "tokenAddress",
      "required": false,
      "schema": {
        "description": "Get a specific token by contract address",
        "type": "string"
      }
    },
    {
      "description": "Limit tokens to a specific symbol.",
      "in": "query",
      "name": "symbol",
      "required": false,
      "schema": {
        "description": "Limit tokens to a specific symbol.",
        "type": "string"
      }
    },
    {
      "description": "Limit tokens to a specific name.",
      "in": "query",
      "name": "name",
      "required": false,
      "schema": {
        "description": "Limit tokens to a specific name.",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "pagination": {
                "properties": {
                  "hasMore": {
                    "description": "Whether there are more items available",
                    "type": "boolean"
                  },
                  "limit": {
                    "default": 20,
                    "description": "Number of items per page",
                    "nullable": true,
                    "type": "number"
                  },
                  "page": {
                    "default": 1,
                    "description": "Current page number",
                    "nullable": true,
                    "type": "number"
                  },
                  "totalCount": {
                    "description": "Total number of items available",
                    "nullable": true,
                    "type": "number"
                  }
                },
                "type": "object"
              },
              "tokens": {
                "items": {
                  "properties": {
                    "address": {
                      "description": "A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth).",
                      "type": "string"
                    },
                    "chainId": {
                      "description": "The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism).",
                      "examples": [
                        1,
                        8453,
                        137,
                        56,
                        43114,
                        42161,
                        10
                      ],
                      "exclusiveMinimum": true,
                      "minimum": 0,
                      "type": "integer"
                    },
                    "decimals": {
                      "type": "number"
                    },
                    "iconUri": {
                      "type": "string"
                    },
                    "prices": {
                      "additionalProperties": {
                        "type": "number"
                      },
                      "description": "Token price in different FIAT currencies.",
                      "examples": [
                        {
                          "EUR": 0.84,
                          "USD": 1
                        }
                      ],
                      "type": "object"
                    },
                    "symbol": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "chainId",
                    "address",
                    "decimals",
                    "symbol",
                    "prices"
                  ],
                  "type": "object"
                },
                "type": "array"
              }
            },
            "required": [
              "pagination",
              "tokens"
            ],
            "type": "object"
          }
        }
      },
      "description": "Tokens returned successfully."
    },
    "400": {
      "description": "Invalid request parameters."
    },
    "401": {
      "description": "Authentication required. For backend usage, include `x-secret-key` header. For frontend usage, include `x-client-id` + `Authorization: Bearer <jwt>` headers."
    },
    "500": {
      "description": "Internal server error. This may occur due to network connectivity issues, wallet creation failures, or transaction execution failures."
    }
  }
}