Breeze
Endpoints

Get Breeze Balances

GET
/breeze-balances/{user_id}

Retrieves detailed balance information for a user, including strategy details, token information, position values, deposited amounts, yield earned, APY, and last update timestamp.

x-api-key<token>

In: header

Path Parameters

user_id*string

Fund user identifier (wallet address)

Query Parameters

strategy_id*string

Filter by specific strategy ID

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
per_page?integer

Items per page, default 1000

Formatint32
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/breeze-balances/string?strategy_id=string"
{  "data": [    {      "strategy_name": "string",      "strategy_id": "string",      "fund_id": "string",      "token_address": "string",      "token_symbol": "string",      "token_name": "string",      "decimals": 0,      "total_position_value": 0,      "total_deposited_value": 0,      "yield_earned": 0,      "apy": 0.1,      "last_updated": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0,    "has_more": true  }}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}