Skip to main content
GET
/
clients
/
me
/
integrations
/
yield-xyz
/
yields
Get yield opportunities
curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/yields \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "rawResponse": [
      {}
    ]
  }
}

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.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
offset
integer

Number of results to skip. Defaults to 0.

​
limit
integer

Maximum number of results to return. Defaults to 100.

​
network
string

Network identifier in CAIP-2 format (e.g. eip155:1).

​
networks
string[]

Filter by multiple networks (CAIP-2 format).

​
yieldId
string

Filter by a specific yield opportunity ID.

​
yieldIds
string[]

Filter by multiple yield opportunity IDs.

​
type
enum<string>

Type of yield mechanism.

Available options:
staking,
restaking,
lending,
vault,
fixed_yield,
real_world_asset
​
types
enum<string>[]

Filter by multiple yield mechanism types.

Available options:
staking,
restaking,
lending,
vault,
fixed_yield,
real_world_asset
​
hasCooldownPeriod
boolean

Filter to opportunities with (or without) a cooldown period.

​
hasWarmupPeriod
boolean

Filter to opportunities with (or without) a warmup period.

​
token
string

Token contract address to filter by.

​
inputToken
string

Input token symbol or address.

​
inputTokens
string[]

Filter by multiple input tokens (symbols or addresses).

​
provider
string

Protocol provider (e.g. aave, compound).

​
providers
string[]

Filter by multiple providers.

​
search
string

Search term for yield opportunities.

​
sort
enum<string>

Sorting criteria.

Available options:
statusEnterAsc,
statusEnterDesc,
statusExitAsc,
statusExitDesc

Response

Yield opportunities retrieved successfully

​
data
object