GET
/
user-balances
/
{user_id}
cURL
curl --request GET \
  --url https://api.breeze.baby/user-balances/{user_id} \
  --header 'x-api-key: <api-key>'
{
  "balances": [
    {
      "asset": "<string>",
      "fund_positions": [
        {
          "apy": "<string>",
          "fund_id": "<string>",
          "fund_name": "<string>",
          "position_value": "<string>",
          "yield_earned": "<string>"
        }
      ],
      "symbol": "<string>",
      "total_balance": "<string>",
      "total_yield": "<string>",
      "wallet_balance": "<string>"
    }
  ],
  "total_portfolio_value": "<string>",
  "total_yield_earned": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
user_id
string
required

Fund user identifier

Query Parameters

​
asset
string

Filter by specific asset

​
sort_by
string

Sort by balance, default 'balance'

​
sort_order
string

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

Response

200
application/json

User balances retrieved successfully

The response is of type object.