Breeze
Endpoints

Get User Yield

GET
/user-yield/{user_id}

Retrieves the total yield earned by a user across all their positions. Supports optional currency conversion and filtering by balance or base asset.

x-api-key<token>

In: header

Path Parameters

user_id*string

Fund user identifier

Query Parameters

fund_id?string

Filter by specific fund

page?integer

Page number for pagination, default 1

Formatint32
Range0 <= value
limit?integer

Items per page, default 10

Formatint32
Range0 <= value

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/user-yield/string"
{  "data": [    {      "apy": 0.1,      "base_asset": "string",      "entry_date": "string",      "fund_id": "string",      "fund_name": "string",      "last_updated": "string",      "position_value": 0,      "yield_earned": 0    }  ],  "meta": {    "has_more": true,    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
{  "message": "string"}
{  "message": "string"}