Skip to main content
GET
/
breeze-balances
/
{user_id}
Get user balances with strategy information
curl --request GET \
  --url https://api.breeze.com/breeze-balances/{user_id} \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "strategy_name": "<string>",
      "strategy_id": "<string>",
      "fund_id": "<string>",
      "token_address": "<string>",
      "token_symbol": "<string>",
      "token_name": "<string>",
      "decimals": 123,
      "total_position_value": 123,
      "total_deposited_value": 123,
      "yield_earned": 123,
      "apy": 123,
      "last_updated": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123,
    "has_more": true
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

user_id
string
required

Fund user identifier (wallet address)

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

Required range: x >= 0
per_page
integer

Items per page, default 1000

Required range: x >= 0

Response

Breeze balances retrieved successfully

data
object[]
required
meta
object
required

Pagination metadata