v1

latestOpenAPI 3.0.02026-07-2442138225.7 KB
Discovery

List all yield opportunities

Retrieve a paginated list of available yield opportunities across all supported networks and protocols.

get/v1/yields

Query parameters

offsetnumber

Offset for pagination

limitnumber

Number of items per page

network'ethereum' | 'ethereum-goerli' | 'ethereum-holesky' | 'ethereum-sepolia' | 'ethereum-hoodi' | 'arbitrum' | 'base' | 'base-sepolia' | 'gnosis' | 'optimism' | 'polygon' | 'polygon-amoy' | 'starknet' | 'zksync' | 'linea' | 'unichain' | 'monad-testnet' | 'monad' | 'robinhood' | 'robinhood-testnet' | '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'

Filter by network

chainIdstring

Filter by EVM chain ID (Ethereum: 1, Polygon: 137)

networksstring

Filter by multiple networks (comma separated)

yieldIdstring
yieldIdsstring[]
type'staking' | 'restaking' | 'lending' | 'vault' | 'fixed_yield' | 'real_world_asset' | 'concentrated_liquidity_pool' | 'liquidity_pool' | 'liquid_staking'

Filter by yield type

typesstring[]

Filter by multiple yield types (comma separated)

hasCooldownPeriodboolean

Filter by cooldown period

hasWarmupPeriodboolean

Filter by warmup period

tokenstring

Filter by token symbol or address

inputTokenstring

Filter by input token symbol or address

inputTokensstring[]

Filter by multiple input token symbol or address (comma separated)

providerstring

Filter by provider ID

providersstring[]

Filter by multiple provider IDs (comma separated)

searchstring

Search by yield name

primeboolean

Filter by the Prime quality flag. true returns only Prime yields; false returns only non-Prime yields; omitting the parameter returns the full catalog. Composable with all other filters.

sort'statusEnterAsc' | 'statusEnterDesc' | 'statusExitAsc' | 'statusExitDesc' | 'rewardRateAsc' | 'rewardRateDesc'

Sort by yield status or reward rate

Response

Returns a paginated list of yield opportunities

totalnumber required

Total number of items available

offsetnumber required

Offset of the current page

limitnumber required

Limit of the current page