Breeze
Endpoints

Get User Balances

GET
/user-balances/{user_id}

Retrieves balance information for a user with optional filtering by asset. Returns position values and deposit amounts with pagination support.

x-api-key<token>

In: header

Path Parameters

user_id*string

Fund user identifier

Query Parameters

asset?string

Filter by specific asset (token symbol or mint address)

sort_by?string

Sort by balance, default 'balance'

sort_order?string

Sort order: 'asc' or 'desc', default 'desc'

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-balances/string"
{  "data": [    {      "decimals": 0,      "token_address": "string",      "token_name": "string",      "token_symbol": "string",      "total_balance": 0,      "yield_balance": {        "amount_of_yield": "string",        "fund_apy": 0.1,        "fund_id": "string",        "funds": "string"      }    }  ],  "meta": {    "has_more": true,    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
{  "message": "string"}
{  "message": "string"}