GET
/
user-yield
/
{user_id}
cURL
curl --request GET \
  --url https://api.breeze.baby/user-yield/{user_id} \
  --header 'x-api-key: <api-key>'
{
  "pagination": {
    "limit": 1,
    "page": 1,
    "total_items": 1,
    "total_pages": 1
  },
  "total_yield_earned": "<string>",
  "yields": [
    {
      "apy": "<string>",
      "base_asset": "<string>",
      "entry_date": "<string>",
      "fund_id": "<string>",
      "fund_name": "<string>",
      "last_updated": "<string>",
      "position_value": "<string>",
      "yield_earned": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
user_id
string
required

Fund user identifier

Query Parameters

​
fund_id
string

Filter by specific fund

​
page
integer

Page number for pagination, default 1

Required range: x >= 0
​
limit
integer

Items per page, default 10

Required range: x >= 0

Response

200
application/json

User yield data retrieved successfully

The response is of type object.