# Balances

Use API key authentication for every endpoint on this page.

Need live balance deltas.

Use [Balance Updates](https://docs.outpoll.com/api/rest-api/websockets/account-and-history-streams/balance-updates) for the `balance/ws` stream.

### Get User Balances

```
GET /api/user-balances
```

#### Query parameters

| Parameter     | Type    | Required | Default | Description                         |
| ------------- | ------- | -------- | ------- | ----------------------------------- |
| eventTokenIds | string  | No       | —       | Comma-separated token IDs to filter |
| page          | integer | No       | 0       | Page number                         |
| size          | integer | No       | 100     | Items per page                      |

#### Response `200 OK`

```json
{
  "i": [
    {
      "i": "balance-id",
      "u": "user-id",
      "et": "event-token-id",
      "aop": 0.5,
      "c": 50,
      "v": 55,
      "tv": 55
    }
  ],
  "p": 0,
  "s": 100,
  "tp": 1
}
```

| Field | Type   | Description        |
| ----- | ------ | ------------------ |
| i     | string | Balance ID         |
| u     | string | User ID            |
| et    | string | Event token ID     |
| aop   | number | Average open price |
| c     | number | Cost               |
| v     | number | Value              |
| tv    | number | Total value        |

### Get Full Balances

```
GET /api/user-balances/full
```

#### Response `200 OK`

Uses the same paginated wrapper as `/api/user-balances`.

Each item includes the base fields plus:

| Field | Type    | Description    |
| ----- | ------- | -------------- |
| eq    | string  | Event question |
| ei    | string  | Event icon URL |
| es    | string  | Event slug     |
| on    | string  | Outcome name   |
| tn    | string  | Token name     |
| ip    | boolean | Primary flag   |