> ## Documentation Index
> Fetch the complete documentation index at: https://data.birdeye.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Token - List (V1)

> Retrieve a list of tokens on a specified chain.

<Tabs>
  <Tab title="Usage Note">
    <p><strong>Legacy token directory list.</strong></p>

    <ul>
      <li>This is the lighter token-list endpoint for broad token browsing on one chain.</li>
      <li><code>limit</code> supports <code>1</code> to <code>50</code> items per request.</li>
      <li><code>sort\_by</code> supports <code>mc</code>, <code>v24hUSD</code>, <code>v24hChangePercent</code>, and <code>liquidity</code>.</li>
      <li><code>min\_liquidity</code> defaults to <code>100</code>, which helps filter low-signal assets from the default result set.</li>
      <li><code>ui\_amount\_mode</code> affects token-amount fields where chain-specific scaled balances are relevant.</li>
    </ul>
  </Tab>

  <Tab title="Accessibility">
    <ul>
      <li>Standard</li>
      <li>Lite</li>
      <li>Starter</li>
      <li>Premium</li>
      <li>Business</li>
      <li>Enterprise</li>
    </ul>
  </Tab>

  <Tab title="Chain Supported">
    <p><strong>All chains ⛓️ ✨</strong></p>
  </Tab>
</Tabs>

<Accordion title="Compute Unit ⚙️" icon="fa-gauge-high">
  <ul>
    <li>This endpoint consumes <code>30 CU</code> per request.</li>
  </ul>
</Accordion>

<Accordion title="Use Cases 💡" icon="fa-lightbulb">
  <ul>
    <li>Build token registries, simple token explorers, and asset-picking dropdowns.</li>
    <li>Power lightweight ranked lists by liquidity, market cap, or 24h volume.</li>
    <li>Preload token identity and summary rows before deeper market-data calls.</li>
    <li>Support simple browse flows where V3 screening would be overkill.</li>
  </ul>
</Accordion>

<Accordion title="How to Use 🛠️" icon="fa-book-open">
  <ul>
    <li>Set <code>x-chain</code> for the target network.</li>
    <li>Choose <code>sort\_by</code> and <code>sort\_type</code> for the ranking you want.</li>
    <li>Page with <code>offset</code> and <code>limit</code>, keeping <code>limit</code> at <code>50</code> or below.</li>
    <li>Use <code>min\_liquidity</code> and optional <code>max\_liquidity</code> to bound the result set.</li>
  </ul>
</Accordion>

<Accordion title="Best Practices ✅" icon="fa-check-circle">
  <ul>
    <li>Treat this as a browse endpoint, not a full screener; move to V3 when you need richer filters.</li>
    <li>Keep <code>min\_liquidity</code> explicit in production screens so result quality stays predictable.</li>
    <li>Cache token-list pages briefly when multiple users are likely to hit the same leaderboard view.</li>
  </ul>
</Accordion>

<br />


## OpenAPI

````yaml openapi/data/openapi_docs.json GET /defi/tokenlist
openapi: 3.1.0
info:
  version: 1.1.0
  title: Birdeye Data API
  description: >-
    Birdeye Data API is a full-spectrum blockchain and DEX data platform for
    teams that need production-grade crypto market intelligence across tokens,
    pairs, wallets, traders, protocols, and chains.


    From real-time prices, OHLCV, liquidity, and transaction flow to holder
    analytics, token and pair overviews, wallet portfolio and PnL, smart money,
    discovery, security, and blockchain-level utilities, Birdeye gives you a
    unified data layer for building serious crypto products at scale.


    Use it to power exchange interfaces, trading terminals, bots, market-making
    systems, quant research, alpha screeners, portfolio apps, wallet
    intelligence tools, alerting systems, analytics dashboards, and back-office
    data pipelines. Whether your users are retail traders, pro desks, analysts,
    or infrastructure teams, Birdeye helps you ship faster with broad market
    coverage and API surfaces that support both lightweight integrations and
    data-heavy workflows.


    To start, create an account at [bds.birdeye.so](https://bds.birdeye.so),
    generate an API key from the `Security` tab, and send it in the `X-API-KEY`
    header on every request.
servers:
  - url: https://public-api.birdeye.so
security:
  - apiKeyAuth: []
tags:
  - name: Price & OHLCV
  - name: Stats
  - name: Token/Market List
  - name: Transactions
  - name: Wallet, Networth & PnL
  - name: Balance & Transfer
  - name: Holder
  - name: Alltime & History
  - name: Blockchain
  - name: Account
  - name: Token
  - name: Transaction
  - name: Creation & Trending
  - name: Meme
  - name: Security
  - name: Search & Utils
  - name: Smart Money
  - name: Global Fees Paid
  - name: DEX & Protocol
  - name: Wallet Identity
paths:
  /defi/tokenlist:
    get:
      tags:
        - Token/Market List
      summary: Token - List (V1)
      description: Retrieve a list of tokens on a specified chain.
      operationId: get-defi-tokenlist
      parameters:
        - $ref: '#/components/parameters/xChainParam'
        - $ref: '#/components/parameters/sortByTokenListParam'
        - $ref: '#/components/parameters/sortTypeParam'
        - $ref: '#/components/parameters/offsetParam'
        - $ref: '#/components/parameters/limitParam'
        - $ref: '#/components/parameters/minLiquidityParam'
        - $ref: '#/components/parameters/tokenListV1MaxLiquidityParam'
        - $ref: '#/components/parameters/uiAmountModeSplitParam'
      responses:
        '200':
          $ref: '#/components/responses/DefiTokenListV1'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
components:
  parameters:
    xChainParam:
      name: x-chain
      description: A chain name listed in supported networks.
      in: header
      required: false
      schema:
        type: string
        enum:
          - solana
          - ethereum
          - bsc
          - base
          - robinhood
          - sui
          - mantle
          - hyperevm
          - arbitrum
          - avalanche
          - optimism
          - polygon
          - zksync
          - monad
          - aptos
          - fogo
          - megaeth
        default: solana
    sortByTokenListParam:
      name: sort_by
      description: Specify the sort field.
      in: query
      required: true
      schema:
        type: string
        enum:
          - mc
          - v24hUSD
          - v24hChangePercent
          - liquidity
        default: v24hUSD
    sortTypeParam:
      name: sort_type
      description: Specify the sort order.
      in: query
      required: true
      schema:
        type: string
        enum:
          - desc
          - asc
        default: desc
    offsetParam:
      name: offset
      description: >-
        Specify the offset for pagination. Filter for records with offset
        greater than the specified offset value, including those with offset
        equal to the specified offset.
      in: query
      required: false
      schema:
        type: integer
        default: 0
    limitParam:
      name: limit
      description: Number of items per page.
      in: query
      required: false
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 50
    minLiquidityParam:
      name: min_liquidity
      description: >-
        Specify the lower bound of liquidity. Filter for records with liquidity
        greater than the minimum liquidity value, excluding those with liquidity
        equal to the minimum.
      in: query
      required: false
      schema:
        type: number
        default: 100
        minimum: 0
    tokenListV1MaxLiquidityParam:
      name: max_liquidity
      description: >-
        Specify the upper bound of liquidity. Filter for records with liquidity
        less than the maximum liquidity value, excluding those with liquidity
        equal to the maximum.
      in: query
      required: false
      schema:
        type: number
        exclusiveMinimum: 0
    uiAmountModeSplitParam:
      name: ui_amount_mode
      description: >-
        Indicate whether to use the scaled amount for scaled ui amount tokens.
        Only support solana
      in: query
      required: false
      schema:
        type: string
        enum:
          - raw
          - scaled
        default: scaled
  responses:
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Bad request
    '401':
      description: Unauthorized. API key is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Unauthorized
    '403':
      description: Forbidden. Request is blacklisted or not whitelisted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Access Denied
    '429':
      description: Too Many Requests. Rate limit reached
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Too many requests
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal Server Error
    DefiTokenListV1:
      description: JSON object containing a list of tokens with certain fields
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DefiTokenListV1Response'
          examples:
            SolanaScaledUIAmount:
              value:
                success: true
                data:
                  updateUnixTime: 1754885276
                  updateTime: '2025-08-11T04:07:56.945Z'
                  tokens:
                    - isScaledUiToken: false
                      multiplier: null
                      address: So11111111111111111111111111111111111111112
                      decimals: 9
                      price: 185.45023454574132
                      lastTradeUnixTime: 1754885221
                      liquidity: 23349538049.2037
                      logoURI: >-
                        https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/So11111111111111111111111111111111111111112/logo.png
                      mc: 100058305776.50261
                      name: Wrapped SOL
                      symbol: SOL
                      v24hChangePercent: -1.4820129368250423
                      v24hUSD: 9515832024.915321
                  total: 298068
            Tokens:
              value:
                success: true
                data:
                  updateUnixTime: 1726679660
                  updateTime: '2024-09-18T17:14:20'
                  tokens:
                    - address: So11111111111111111111111111111111111111112
                      decimals: 9
                      price: 152.37270634528284
                      lastTradeUnixTime: 1726679251
                      liquidity: 7027121030.361493
                      logoURI: >-
                        https://img.fotofolio.xyz/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolana-labs%2Ftoken-list%2Fmain%2Fassets%2Fmainnet%2FSo11111111111111111111111111111111111111112%2Flogo.png
                      mc: 75217627246.4999
                      name: Wrapped SOL
                      symbol: SOL
                      v24hChangePercent: -6.4865412491445245
                      v24hUSD: 753340393.0850035
                    - address: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
                      decimals: 6
                      price: 0.99997
                      lastTradeUnixTime: 1726679250
                      liquidity: 3507793000.4033475
                      logoURI: >-
                        https://img.fotofolio.xyz/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolana-labs%2Ftoken-list%2Fmain%2Fassets%2Fmainnet%2FEPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v%2Flogo.png
                      mc: 2973865527.5120635
                      name: USD Coin
                      symbol: USDC
                      v24hChangePercent: -20.022827653450364
                      v24hUSD: 364654013.9369947
                  total: 455148
  schemas:
    DefiTokenListV1Response:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Whether the request completed successfully.
        data:
          type: object
          description: Paged token-list payload with ranking metadata and token rows.
          properties:
            updateUnixTime:
              type: integer
              description: >-
                Unix timestamp in seconds when the token list snapshot was last
                refreshed.
            updateTime:
              type: string
              description: >-
                Human-readable timestamp when the token list snapshot was last
                refreshed.
            total:
              type: number
              description: >-
                Total number of tokens matching the request before pagination is
                applied.
            tokens:
              type: array
              description: Token rows returned for the current page.
              items:
                type: object
                description: One token row from the V1 token list.
                properties:
                  address:
                    type: string
                    description: Token mint or contract address.
                  decimals:
                    type: integer
                    description: Number of decimal places used by the token.
                  lastTradeUnixTime:
                    type: integer
                    description: >-
                      Unix timestamp in seconds of the latest observed trade for
                      the token.
                  liquidity:
                    type: number
                    description: Current token liquidity in USD.
                  logoURI:
                    type: string
                    description: Logo image URL for the token.
                  mc:
                    type: number
                    description: Current market capitalization.
                  name:
                    type: string
                    description: Display name of the token.
                  symbol:
                    type: string
                    description: Ticker symbol for the token.
                  v24hChangePercent:
                    type: number
                    description: >-
                      Percentage change in 24-hour traded token volume versus
                      the previous 24-hour window.
                  v24hUSD:
                    type: number
                    description: Total traded USD volume during the latest 24-hour window.
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key for authentication

````