Get balances
GET/v1/balances
Get current currency balance from all or single exchange.
Request
Query Parameters
Filter the balances to the specific exchange.
Responses
- 200
- 490
Collection of balances.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Exchange identifier used to identify the routing destination.
data
object[]
Exchange currency code.
CoinAPI currency code.
Value of the current total currency balance on the exchange.
Value of the current available currency balance on the exchange that can be used as collateral.
Value of the current locked currency balance by the exchange.
Possible values: [INITIALIZATION, BALANCE_MANAGER, EXCHANGE]
Source of the last modification.
Current exchange rate to the USD for the single unit of the currency.
Value of the current total traded.
[
{
"exchange_id": "KRAKEN",
"data": [
{
"asset_id_exchange": "XBT",
"asset_id_coinapi": "BTC",
"balance": 0.00134444,
"available": 0.00134444,
"locked": 0,
"last_updated_by": "EXCHANGE",
"rate_usd": 1355.12,
"traded": 0.007
}
]
}
]
Exchange is unreachable.
- appliction/json
- Schema
- Example (from schema)
Schema
Message type, constant.
Possible values: [OTHER, EXCHANGE_UNREACHABLE, EXCHANGE_RESPONSE_TIMEOUT, ORDER_ID_NOT_FOUND, INVALID_TYPE, METHOD_NOT_SUPPORTED, JSON_ERROR]
Cause of rejection.
If the message related to exchange, then the identifier of the exchange will be provided.
Message text.
Value of rejected request, if available.
{
"type": "MESSAGE_REJECT",
"reject_reason": "ORDER_ID_NOT_FOUND",
"exchange_id": "BINANCE",
"message": "Order with ID: BINANCE-7d8a-4888 not found",
"rejected_message": "{\"client_order_id\":\"BINANCE-7d8a-4888\",\"exchange_id\":\"BINANCE\",\"type\":\"ORDER_CANCEL_SINGLE_REQUEST\"}"
}