> ## Documentation Index > Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt > Use this file to discover all available pages before exploring further. # Get default yield opportunities > Returns Portal's recommended yield opportunities per chain and token. By default, returns only the yield IDs (lightweight). Pass `includeOpportunities=true` to enrich each entry with live data (APY, status, mechanics, etc.) from Yield.xyz. Entries with no recommendation return `null` for both `yieldId` and `opportunity`. ## OpenAPI ````yaml /openapi/client-api.yaml get /clients/me/integrations/yield-xyz/yields/defaults openapi: 3.1.0 info: title: Portal Client API version: '3.0' description: > The Portal Client API provides endpoints for managing wallets, building transactions, and interacting with blockchain networks. All endpoints require authentication via a Client API Key or Client Session Token (CST) passed as a Bearer token. ## Base URL `https://api.portalhq.io/api/v3` ## Authentication Include your Client API Key or Client Session Token as a Bearer token in the `Authorization` header of every request. ## Chain ID Format Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or CAIP-2 format (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using CAIP-2 format in URLs, ensure the colon is URI-encoded (`%3A`). servers: - url: https://api.portalhq.io/api/v3 description: Production security: - bearerAuth: [] tags: - name: Clients description: Core client management endpoints - name: Wallet description: >- Read wallet state — balances, NFTs, transaction history, capabilities, and transaction details - name: Transactions description: Build, broadcast, and evaluate blockchain transactions - name: Funding description: Fund wallets with testnet tokens - name: Wallet Shares description: Manage signing and backup share pairs - name: Delegations description: Manage token approvals, revocations, and delegated transfers - name: Session Keys description: Manage EIP-7702 session keys for smart accounts - name: 0x description: Token swap endpoints powered by the 0x protocol - name: Yield.xyz description: Yield opportunities and staking actions powered by Yield.xyz - name: Li.Fi description: Cross-chain swaps and bridging powered by Li.Fi - name: Blockaid description: Transaction and address security scanning powered by Blockaid - name: Hypernative description: >- Transaction, address, token, and NFT security scanning powered by Hypernative - name: Noah description: KYC onboarding, payins, and payouts powered by Noah - name: Meld description: Buy and sell crypto with fiat through aggregated providers powered by Meld - name: EIP-7702 description: EIP-7702 account type detection and authorization management - name: Deprecated description: >- Legacy endpoints scheduled for removal. Use the newer equivalents listed in each endpoint's description. paths: /clients/me/integrations/yield-xyz/yields/defaults: get: tags: - Yield.xyz summary: Get default yield opportunities description: | Returns Portal's recommended yield opportunities per chain and token. By default, returns only the yield IDs (lightweight). Pass `includeOpportunities=true` to enrich each entry with live data (APY, status, mechanics, etc.) from Yield.xyz. Entries with no recommendation return `null` for both `yieldId` and `opportunity`. operationId: getDefaultYieldOpportunities parameters: - name: chainId in: query schema: type: string description: >- Filter by chain in CAIP-2 format (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). - name: token in: query schema: type: string description: Filter by token symbol (e.g. `ETH`, `USDC`). Case-insensitive. - name: includeOpportunities in: query schema: type: string enum: - 'true' description: >- Set to `true` to enrich each entry with live yield opportunity details from Yield.xyz. Omit for a lightweight response with yield IDs only. responses: '200': description: Default yield opportunities retrieved successfully content: application/json: schema: type: object properties: data: type: object description: > Object keyed by `{caip2ChainId}:{tokenSymbol}` (e.g. `eip155:1:ETH`). Access entries directly by key — no iteration needed. additionalProperties: type: object properties: yieldId: type: string nullable: true description: >- The recommended Yield.xyz yield ID, or `null` if no recommendation exists. opportunity: $ref: '#/components/schemas/YieldOpportunity' nullable: true description: >- Full yield opportunity details from Yield.xyz. Always `null` unless `includeOpportunities=true` is passed. '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: YieldOpportunity: type: object description: >- A yield opportunity with live data from Yield.xyz including rates, status, mechanics, and token info. additionalProperties: true properties: id: type: string description: Unique yield opportunity identifier. example: ethereum-usdc-aave-v3-lending network: type: string description: Network in CAIP-2 format. example: eip155:1 token: type: object description: Primary token for this yield. additionalProperties: true rewardRate: type: object description: Current reward rate breakdown. additionalProperties: true status: type: object properties: enter: type: boolean exit: type: boolean mechanics: type: object description: >- Yield mechanics (type, warmup/cooldown, validator requirements, etc.). additionalProperties: true ErrorResponse: type: object properties: error: type: string description: Error message describing what went wrong securitySchemes: bearerAuth: type: http scheme: bearer description: > Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header. ````