---
title: "Get strategy-scoped Breeze balances"
method: GET
path: "/breeze-balances/{user_id}"
tags: ["User Data"]
---

# Get strategy-scoped Breeze balances

`GET /breeze-balances/{user_id}`

## Request

- Base URL: `https://api.breeze.baby`
- URL: `https://api.breeze.baby/breeze-balances/{user_id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/breeze-baby/apis/breeze-api/docs/breeze-balances/:user_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a user's Breeze positions for one strategy, including principal, current value after strategy fees, yield after strategy fees, APY percentage points, and pagination metadata.

## Path parameters

- `user_id` string, required

## Query parameters

- `asset` string
- `sort_by` string
- `sort_order` string
- `page` integer
- `limit` integer
- `strategy_id` string, required

## Response `200`

Breeze balances retrieved successfully

- BreezeBalancesResponse
  - `data` BreezeBalance[], required
    - `apy` number, double, required: Current annual percentage yield expressed as percentage points.
    - `decimals` integer, required: Number of base-asset decimal places.
    - `fund_id` string, required: Fund account address.
    - `last_updated` string, required: ISO 8601 timestamp for the mirrored position update.
    - `strategy_id` string, required: Strategy identifier.
    - `strategy_name` string, required: Name of the strategy containing this position.
    - `token_address` string, required: Base-asset mint address.
    - `token_name` string, required: Base-asset display name.
    - `token_symbol` string, required: Base-asset symbol.
    - `total_deposited_value` integer, required: Principal deposited, in the token's smallest unit.
    - `total_position_value` integer, required: Current position value after strategy fees, in the token's smallest unit.
    - `yield_earned` integer, required: Yield after strategy fees, in the token's smallest unit.
  - `meta` PaginationMeta, required: Pagination metadata
    - `has_more` boolean, required: Whether there are more pages
    - `page` integer, required: Current page number
    - `per_page` integer, required: Number of items per page
    - `total` integer, required: Total number of items
    - `total_pages` integer, required: Total number of pages

## Other responses

- `400`: Missing strategy identifier
- `401`: Missing API key
- `404`: Invalid, inactive, or expired API key
- `500`: Internal server error

---

[API](https://skmtc.dev/breeze-baby/apis/breeze-api.md) - [All operations](https://skmtc.dev/breeze-baby/apis/breeze-api/llms.txt) - [OpenAPI document](https://skmtc.dev/breeze-baby/apis/breeze-api/revisions/d0a18846aa92?raw)