---
title: "Get balance"
url: https://docs.truemarkets.co/api/institutional/get-balances-cefi
description: "Query for balance information current allocated to the exchange."
---

Docs index: https://docs.truemarkets.co/llms.txt

# Get balance

Query for balance information current allocated to the exchange.

## Request

```
GET https://api.truex.co/v1/cefi/balances
```

### Authentication

Bearer token in `Authorization`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-truex-auth-timestamp` | header | string | yes | Timestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future. It guards against replayed requests. |
| `asset_id` | query | string | no | ID of asset to query balance information for. |
| `asset_name` | query | string | no | Name of asset to query balance information for. ASCII alphanumeric only. |
| `client_id` | query | string | no | Exchange generated client ID to query balance information for. |

## Responses

Every error status returns the same body, described in [Errors](https://docs.truemarkets.co/developer-resources/errors.md).

### 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `[].id` | string | no | Exchange assigned entity ID. |
| `[].status` | string, one of `INVALID` | no | Exchange only status value, will always be INVALID. |
| `[].unsettled_fees` | string | no | Account-level fees accrued from trading but not yet settled, denominated in the fee asset (settlement stablecoin). Reduces the tradable/withdrawable amount of the fee asset only. |
| `[].fees_hold` | string | no | Account-level amount of the fee asset held against anticipated fees on open orders. Reduces the tradable/withdrawable amount of the fee asset only. |
| `[].balances` | array of object | no |  |
| `[].balances[].asset_id` | string | no | Exchange assigned entity ID. For balance entities this will be the same as your client id. |
| `[].balances[].balance` | string | no | Gross amount of asset on the exchange. This is NOT your tradable amount — it does not exclude holds. See `order_hold`, `transfer_hold`, and the schema description for how to derive tradable/withdrawable amounts. |
| `[].balances[].unsettled` | string | no | Net amount traded but awaiting settlement by the asset custodian. Positive = inbound (counts toward tradable, not withdrawable); negative = an outbound obligation (reduces both tradable and withdrawable). |
| `[].balances[].order_hold` | string | no | Amount held against open/resting orders. Subtract from `balance` to get tradable amount; released as orders fill or cancel. |
| `[].balances[].transfer_hold` | string | no | Amount held against pending transfers/withdrawals. Subtract from `balance` to get tradable amount; released when the transfer settles or is rejected. |
| `[].balances[].state` | string, one of `INVALID`, `INITIALIZED`, `OPEN`, `LOCKED`, `CLOSING` | no | Current state of the balance. * **INVALID** Balance is not active on the exchange and currently in an error state. * **INITIALIZED** Balance has been created on the exchange but is not currently active. * **OPEN** Balance is active on the exchange. * **LOCKED** Balance is on the exchange but cannot be used for transactions. * **CLOSING** Balance is currently be moved off of the exchange and cannot be used for transactions." |

### 400

Bad request.

### 401

Unauthorized.

### 403

Forbidden.

### 408

Request timeout.

### 415

Unsupported media type.

### 500

Internal server error.

### 503

Service unavailable.
