> ## 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 yield opportunities > Retrieves a paginated list of available yield opportunities across all supported networks and protocols. This is a proxy to the Yield.xyz `GET /yields` endpoint. The response is wrapped under `data.rawResponse` and `network` fields are converted to CAIP-2 format. For the full upstream response schema see [docs.yield.xyz](https://docs.yield.xyz/reference/yieldscontroller_getyields). ## OpenAPI ````yaml /openapi/client-api.yaml get /clients/me/integrations/yield-xyz/yields 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: 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: get: tags: - Yield.xyz summary: Get yield opportunities description: > Retrieves a paginated list of available yield opportunities across all supported networks and protocols. This is a proxy to the Yield.xyz `GET /yields` endpoint. The response is wrapped under `data.rawResponse` and `network` fields are converted to CAIP-2 format. For the full upstream response schema see [docs.yield.xyz](https://docs.yield.xyz/reference/yieldscontroller_getyields). operationId: getYieldOpportunities parameters: - name: offset in: query schema: type: integer description: Number of results to skip. Defaults to 0. - name: limit in: query schema: type: integer description: Maximum number of results to return. Defaults to 100. - name: network in: query schema: type: string description: Network identifier in CAIP-2 format (e.g. `eip155:1`). - name: networks in: query schema: type: array items: type: string description: Filter by multiple networks (CAIP-2 format). - name: yieldId in: query schema: type: string description: Filter by a specific yield opportunity ID. - name: yieldIds in: query schema: type: array items: type: string description: Filter by multiple yield opportunity IDs. - name: type in: query schema: type: string enum: - staking - restaking - lending - vault - fixed_yield - real_world_asset description: Type of yield mechanism. - name: types in: query schema: type: array items: type: string enum: - staking - restaking - lending - vault - fixed_yield - real_world_asset description: Filter by multiple yield mechanism types. - name: hasCooldownPeriod in: query schema: type: boolean description: Filter to opportunities with (or without) a cooldown period. - name: hasWarmupPeriod in: query schema: type: boolean description: Filter to opportunities with (or without) a warmup period. - name: token in: query schema: type: string description: Token contract address to filter by. - name: inputToken in: query schema: type: string description: Input token symbol or address. - name: inputTokens in: query schema: type: array items: type: string description: Filter by multiple input tokens (symbols or addresses). - name: provider in: query schema: type: string description: Protocol provider (e.g. `aave`, `compound`). - name: providers in: query schema: type: array items: type: string description: Filter by multiple providers. - name: search in: query schema: type: string description: Search term for yield opportunities. - name: sort in: query schema: type: string enum: - statusEnterAsc - statusEnterDesc - statusExitAsc - statusExitDesc description: Sorting criteria. responses: '200': description: Yield opportunities retrieved successfully content: application/json: schema: $ref: '#/components/schemas/YieldOpportunitiesResponse' '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: YieldOpportunitiesResponse: type: object properties: data: type: object properties: rawResponse: type: array items: type: object description: Yield opportunity object. additionalProperties: true description: Array of yield opportunity objects. 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. ````