---
title: "GET /v1/tokens"
method: GET
path: "/v1/tokens"
tags: ["Tokens"]
deprecated: true
---

# GET /v1/tokens

`GET /v1/tokens`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/tokens`
- Auth: API key in header `x-api-key`

> **Deprecated.**

## Query parameters

- `page` integer: Page number
- `pageSize` integer: Items per page (max 100)
- `chainId` string: Filter by chain ID
- `address` string: Filter by token address
- `assetIds` string[]: Asset IDs as CSV or repeated query values
- `symbol` string: Filter by token symbol
- `name` string: Filter by token name
- `type` 'ERC20' | 'FIAT' | 'NATIVE' | 'REBASE_LST' | 'INTEREST_BEARING' | 'VALUE_ACCRUING' | 'LP_SHARE' | 'DEBT' | 'REFLECT' | 'VOTE_ESCROWED' | 'NFT': Filter by token type
- `sortBy` 'symbol' | 'name' | 'address': Sort by a public token field
- `sortDirection` 'asc' | 'desc': Sort direction for sortBy
- `search` string: Search token address, symbol, or name
- `portfolioSlug` string: Filter balances/preferences to a public portfolio slug
- `walletAddress` string: Filter balances to a wallet address on chainId
- `withComputedBalance` boolean: Only return tokens with computed wallet balance rows
- `safeWalletOnly` boolean: Only return tokens from Safe-enabled wallets
- `isSpam` boolean: Filter by token spam status
- `whitelist` string[]: Whitelisted tokens as chainId:address values

## Response `200`

- PaginatedTokensResponseDto
  - `data` object[], required
    - `chainId` string, required: Chain ID
    - `address` string, required: Token contract or mint address
    - `name` string, required: Token name
    - `symbol` string, required: Token symbol
    - `decimals` integer, required: Token decimals
    - `logoUrl` string, nullable, required: Token logo URL
    - `type` 'ERC20' | 'FIAT' | 'NATIVE' | 'REBASE_LST' | 'INTEREST_BEARING' | 'VALUE_ACCRUING' | 'LP_SHARE' | 'DEBT' | 'REFLECT' | 'VOTE_ESCROWED' | 'NFT', required: Token type
    - `description` string, nullable, required: Token description
    - `metadata` object, nullable, required: Token metadata
    - `nftContractAddress` string, nullable, required: NFT contract address
    - `coingeckoId` string, nullable, required: CoinGecko coin ID
    - `assetId` string, required: Asset ID
    - `isSpam` boolean, required: Whether the token is marked as spam
    - `chain` object, required: Token chain
      - `chainId` string, required: Public chain ID
      - `name` string, required: Chain name
      - `type` 'BLOCKCHAIN' | 'EXCHANGE' | 'BANK', required: Chain type
    - `createdAt` string, date-time, required: Creation timestamp (ISO 8601)
    - `updatedAt` string, date-time, required: Last update timestamp (ISO 8601)
  - `pagination` object, required
    - `page` integer, required: Current page number
    - `pageSize` integer, required: Items per page
    - `totalCount` integer, required: Total number of items
    - `totalPages` integer, required: Total number of pages

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)
