Skip to main content
GET
/
user-balances
/
{user_id}
Get user balances
curl --request GET \
  --url https://api.breeze.baby/user-balances/{user_id} \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "decimals": 123,
      "token_address": "<string>",
      "token_name": "<string>",
      "token_symbol": "<string>",
      "total_balance": 1,
      "yield_balance": {
        "amount_of_yield": "<string>",
        "fund_apy": 123,
        "fund_id": "<string>",
        "funds": "<string>"
      }
    }
  ],
  "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

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<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 balances retrieved successfully

Paginated response wrapper

data
object[]
required
meta
object
required

Pagination metadata