Skip to main content
GET
/
user-yield
/
{user_id}
Get user yield
curl --request GET \
  --url https://api.breeze.baby/user-yield/{user_id} \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "apy": 123,
      "base_asset": "<string>",
      "entry_date": "<string>",
      "fund_id": "<string>",
      "fund_name": "<string>",
      "last_updated": "<string>",
      "position_value": 1,
      "yield_earned": 1
    }
  ],
  "meta": {
    "has_more": true,
    "page": 1,
    "per_page": 1,
    "total": 1,
    "total_pages": 1
  }
}

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<int32>

Page number for pagination, default 1

Required range: x >= 0
limit
integer<int32>

Items per page, default 10

Required range: x >= 0

Response

User yield data retrieved successfully

Paginated response wrapper

data
object[]
required
meta
object
required

Pagination metadata