Skip to main content
GET
Get default yield opportunities

Authorizations

Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Query Parameters

chainId
string

Filter by chain in CAIP-2 format (e.g. eip155:1, solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp).

token
string

Filter by token symbol (e.g. ETH, USDC). Case-insensitive.

includeOpportunities
enum<string>

Set to true to enrich each entry with live yield opportunity details from Yield.xyz. Omit for a lightweight response with yield IDs only.

Available options:
true

Response

Default yield opportunities retrieved successfully

data
object

Object keyed by {caip2ChainId}:{tokenSymbol} (e.g. eip155:1:ETH). Access entries directly by key — no iteration needed.