Discovery

List tokens with available yields

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.

get/v1/tokens

Request

Base URL: https://api.yield.xyz
URL: https://api.yield.xyz/v1/tokens
Auth: API key in header x-api-key

Query parameters

addressstring

Filter by an exact token address. EVM addresses are case-insensitive; case-sensitive network addresses must match exactly.

symbolstring

Filter by an exact token symbol (case-insensitive).

enterboolean

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.

exitboolean

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.

networksstring[]

Filter by one or more networks. Supports repeated values or comma separated values.

yieldTypesstring[]

Filter by one or more yield types. Supports repeated values or comma separated values.

offsetnumber

Offset for pagination

limitnumber

Maximum number of items to return. Omit to return the full list.

Response

Returns tokens with available enabled yields

totalnumber required

Total number of items available

offsetnumber required

Offset of the current page

limitnumber required

Limit of the current page

Example response

{
  "total": 100,
  "limit": 20,
  "items": [
    {
      "token": {
        "symbol": "ETH",
        "name": "Ethereum",
        "decimals": 18,
        "network": "Ethereum",
        "address": "0x...",
        "logoURI": "https://...",
        "isPoints": true,
        "coinGeckoId": "ethereum"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.