# Get balance

Query for balance information current allocated to the exchange.

Endpoint: GET /api/v1/balances
Version: v1.0.3
Security: HMAC

## Header parameters:

  - `x-truex-auth-userid` (string, required)
    Client identifier.

  - `x-truex-auth-timestamp` (string, required)
    Timestamp when request was made in seconds since epoch.

  - `x-truex-auth-token` (string, required)
    The UUID affiliated with the HMAC key.

  - `x-truex-auth-signature` (string, required)
    The computed HMAC signature.

## Query parameters:

  - `asset_id` (string)
    ID of asset to query balance information for.

  - `asset_name` (string)
    Name of asset to query balance information for.

  - `client_id` (string)
    Exchange generated client ID to query balance information for.

## Response 200 fields (application/json):

  - `id` (string)
    Exchange assigned entity ID.
    Example: "78901985055342602"

  - `status` (string)
    Exchange only status value, will always be INVALID.
    Enum: "INVALID"

  - `unsettled_fees` (string)
    Current amount of fee asset that have been accrued due to trading but have yet to be settled with the exchange.
    Example: "9210.236229375"

  - `fees_hold` (string)
    Current amount of fee asset that is being held by the exchange as a result of trading activity.
    Example: "179300.4249165"

  - `balances` (array)

  - `balances.asset_id` (string)
    Exchange assigned entity ID. For balance entities this will be the same as your client id.
    Example: "78901985048264711"

  - `balances.balance` (string)
    Total amount of asset currently placed on the exchange.
    Example: "10000000.45"

  - `balances.unsettled` (string)
    Amount of asset that has been traded on the exchange but is awaiting settlement by the asset custodian.
    Example: "0"

  - `balances.order_hold` (string)
    Amount of asset currently being held by the exchange due to trading activity.
    Example: "3586008.49833"

  - `balances.transfer_hold` (string)
    Amount of asset currently being held by the exchange due to transfer activity.
    Example: "100.00"

  - `balances.state` (string)
    Current state of the balance.
*  Balance is not active on the exchange and currently in an error state.
*  Balance has been created on the exchange but is not currently active.
*  Balance is active on the exchange.
*  Balance is on the exchange but cannot be used for transactions.
*  Balance is currently be moved off of the exchange and cannot be used for transactions."
    Enum: "INVALID", "INITIALIZED", "OPEN", "LOCKED", "CLOSING"

## Response 400 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 401 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 403 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 408 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 415 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 500 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).

## Response 503 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `title` (string, required)
    A short, human-readable summary of the problem type.
    Example: "An Error Occured"

  - `status` (integer, required)
    The HTTP status code generated by the origin server.
    Example: 400

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "A more detailed sentence about the error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem.
    Example: "/api/v1/endpoint"

  - `extensions` (object)
    A map for extension members (custom fields not defined by the RFC).