> ## Documentation Index
> Fetch the complete documentation index at: https://yieldxyz.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List tokens

> List tokens that have at least one enabled yield for your project, with yield availability per token.

Project-scoped. Maintenance, deprecated and decommissioned yields are excluded. `networks` and `yieldTypes` accept repeated values or one comma-separated string. `address` matches an exact token address and `symbol` an exact symbol.

`enter` and `exit` narrow each token's `availableYields`, not only the token list. With no `limit`, the full list is returned: read `total` and page with `offset` and `limit`. Yield type values are in [Yield types](/api-reference/earn-objects#yield-types).


## OpenAPI

````yaml openapi.json GET /v1/tokens
openapi: 3.0.0
info:
  title: 'Yield API: Earn'
  description: API Documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api.yield.xyz
    description: Production
security: []
tags:
  - name: Discovery
    description: >-
      Browse and discover yield opportunities, networks, and providers, plus
      yield-level risk, reward rate, and TVL data
  - name: Portfolio
    description: User-specific balances and KYC status
  - name: Actions
    description: Generate transactions to enter, exit, and manage yields
externalDocs:
  description: For more information
  url: https://docs.yield.xyz
paths:
  /v1/tokens:
    get:
      tags:
        - Discovery
      summary: List tokens with available yields
      description: >-
        Retrieve tokens that have at least one enabled yield available for this
        project. Optionally filter by exact token identity, enter/exit
        availability, networks, and yield types. Returns the full list by
        default; callers should respect `total` and use `offset`/`limit`, as a
        default page size may be introduced in future. Maintenance, deprecated,
        and decommissioned yields are always excluded.
      operationId: TokensController_getTokens_v1
      parameters:
        - name: address
          required: false
          in: query
          description: >-
            Filter by an exact token address. EVM addresses are
            case-insensitive; case-sensitive network addresses must match
            exactly.
          schema:
            maxLength: 256
            type: string
        - name: symbol
          required: false
          in: query
          description: Filter by an exact token symbol (case-insensitive).
          schema:
            maxLength: 64
            type: string
        - name: enter
          required: false
          in: query
          description: >-
            Filter available yields by known enter status. `true` returns tokens
            with enterable yields; `false` returns tokens with yields explicitly
            marked non-enterable. Missing or malformed status defaults to open.
            Narrows each token's `availableYields`; combined with `exit` using
            AND.
          schema:
            type: boolean
        - name: exit
          required: false
          in: query
          description: >-
            Filter available yields by known exit status. `true` returns tokens
            with exitable yields; `false` returns tokens with yields explicitly
            marked non-exitable. Missing or malformed status defaults to open.
            Narrows each token's `availableYields`; combined with `enter` using
            AND. Does not surface deprecated yields.
          schema:
            type: boolean
        - name: networks
          required: false
          in: query
          description: >-
            Filter by one or more networks. Supports repeated values or comma
            separated values.
          schema:
            type: array
            items:
              type: string
              enum:
                - ethereum
                - ethereum-goerli
                - ethereum-holesky
                - ethereum-sepolia
                - ethereum-hoodi
                - arbitrum
                - base
                - base-sepolia
                - gnosis
                - optimism
                - polygon
                - polygon-amoy
                - starknet
                - zksync
                - linea
                - unichain
                - plume
                - monad-testnet
                - monad
                - robinhood
                - robinhood-testnet
                - arc-testnet
                - arc
                - avalanche-c
                - avalanche-c-atomic
                - avalanche-p
                - binance
                - celo
                - fantom
                - harmony
                - moonriver
                - okc
                - viction
                - core
                - sonic
                - plasma
                - katana
                - hyperevm
                - tempo
                - pharos
                - agoric
                - akash
                - axelar
                - band-protocol
                - bitsong
                - canto
                - chihuahua
                - comdex
                - coreum
                - cosmos
                - crescent
                - cronos
                - cudos
                - desmos
                - dydx
                - evmos
                - fetch-ai
                - gravity-bridge
                - injective
                - irisnet
                - juno
                - kava
                - ki-network
                - mars-protocol
                - nym
                - okex-chain
                - onomy
                - osmosis
                - persistence
                - quicksilver
                - regen
                - secret
                - sentinel
                - sommelier
                - stafi
                - stargaze
                - stride
                - teritori
                - tgrade
                - umee
                - sei
                - mantra
                - celestia
                - saga
                - zetachain
                - dymension
                - humansai
                - neutron
                - polkadot
                - kusama
                - westend
                - bittensor
                - aptos
                - binancebeacon
                - cardano
                - near
                - solana
                - solana-devnet
                - stellar
                - stellar-testnet
                - sui
                - tezos
                - tron
                - ton
                - ton-testnet
                - hyperliquid
        - name: yieldTypes
          required: false
          in: query
          description: >-
            Filter by one or more yield types. Supports repeated values or comma
            separated values.
          schema:
            type: array
            items:
              type: string
              enum:
                - staking
                - restaking
                - lending
                - vault
                - fixed_yield
                - real_world_asset
                - concentrated_liquidity_pool
                - liquidity_pool
                - liquid_staking
        - name: offset
          required: false
          in: query
          description: Offset for pagination
          schema:
            minimum: 0
            default: 0
            type: number
        - name: limit
          required: false
          in: query
          description: Maximum number of items to return. Omit to return the full list.
          schema:
            minimum: 1
            type: number
      responses:
        '200':
          description: Returns tokens with available enabled yields
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponseDto'
                  - properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/TokenWithAvailableYieldsDto'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Validation failed
                  error:
                    type: string
                    example: Bad Request
                  statusCode:
                    type: number
                    example: 400
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid API key
                  error:
                    type: string
                    example: Unauthorized
                  statusCode:
                    type: number
                    example: 401
        '429':
          description: Rate limit exceeded
          headers:
            x-ratelimit-limit:
              description: Request limit per window
              schema:
                type: string
            x-ratelimit-remaining:
              description: Remaining requests (will be 0)
              schema:
                type: string
            x-ratelimit-reset:
              description: Unix timestamp when window resets
              schema:
                type: string
            retry-after:
              description: Seconds to wait before retrying
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Rate limit exceeded
                  error:
                    type: string
                    example: Too Many Requests
                  statusCode:
                    type: number
                    example: 429
                  retryAfter:
                    type: number
                    example: 30
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Internal server error
                  error:
                    type: string
                    example: Internal Server Error
                  statusCode:
                    type: number
                    example: 500
      security:
        - ApiKey: []
components:
  schemas:
    PaginatedResponseDto:
      type: object
      properties:
        total:
          type: number
          description: Total number of items available
          example: 100
        offset:
          type: number
          description: Offset of the current page
          example: 0
        limit:
          type: number
          description: Limit of the current page
          example: 20
      required:
        - total
        - offset
        - limit
    TokenWithAvailableYieldsDto:
      type: object
      properties:
        token:
          description: Token with one or more available enabled yields
          allOf:
            - $ref: '#/components/schemas/TokenDto'
        availableYields:
          description: Enabled yield IDs available for this token
          type: array
          items:
            type: string
      required:
        - token
        - availableYields
    TokenDto:
      type: object
      properties:
        symbol:
          type: string
          description: Token symbol
          example: ETH
        name:
          type: string
          description: Token name
          example: Ethereum
        decimals:
          type: number
          description: Token decimal places
          example: 18
        network:
          type: string
          description: Token network
          enum:
            - ethereum
            - ethereum-goerli
            - ethereum-holesky
            - ethereum-sepolia
            - ethereum-hoodi
            - arbitrum
            - base
            - base-sepolia
            - gnosis
            - optimism
            - polygon
            - polygon-amoy
            - starknet
            - zksync
            - linea
            - unichain
            - plume
            - monad-testnet
            - monad
            - robinhood
            - robinhood-testnet
            - arc-testnet
            - arc
            - avalanche-c
            - avalanche-c-atomic
            - avalanche-p
            - binance
            - celo
            - fantom
            - harmony
            - moonriver
            - okc
            - viction
            - core
            - sonic
            - plasma
            - katana
            - hyperevm
            - tempo
            - pharos
            - agoric
            - akash
            - axelar
            - band-protocol
            - bitsong
            - canto
            - chihuahua
            - comdex
            - coreum
            - cosmos
            - crescent
            - cronos
            - cudos
            - desmos
            - dydx
            - evmos
            - fetch-ai
            - gravity-bridge
            - injective
            - irisnet
            - juno
            - kava
            - ki-network
            - mars-protocol
            - nym
            - okex-chain
            - onomy
            - osmosis
            - persistence
            - quicksilver
            - regen
            - secret
            - sentinel
            - sommelier
            - stafi
            - stargaze
            - stride
            - teritori
            - tgrade
            - umee
            - sei
            - mantra
            - celestia
            - saga
            - zetachain
            - dymension
            - humansai
            - neutron
            - polkadot
            - kusama
            - westend
            - bittensor
            - aptos
            - binancebeacon
            - cardano
            - near
            - solana
            - solana-devnet
            - stellar
            - stellar-testnet
            - sui
            - tezos
            - tron
            - ton
            - ton-testnet
            - hyperliquid
          example: Ethereum
        address:
          type: string
          description: Token address (if applicable)
          example: 0x...
        logoURI:
          type: string
          description: Token logo URI
          example: https://...
        isPoints:
          type: boolean
          description: Token is points
          example: true
        coinGeckoId:
          type: string
          description: Token CoinGecko ID
          example: ethereum
      required:
        - symbol
        - name
        - decimals
        - network
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.