Query Total Cash

Returns the full cash data across all currencies for the account.

Request parameters

This endpoint has no required parameters; no account or currency needs to be supplied.

Business notes

Keyed by currency, it returns each currency's settled cash settled_cash and available cash available_cash.

Compared with the account cash query, this endpoint returns all data and does not support currency filtering.

Returns

On success, returns the full cash data. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/whaleapi/asset/query_total_cash

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

account_balance.account

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Responses

HTTP 200Successful response

Standard response envelopecodemessagedata

dataobjectdata structure

total_cashobjectrequired

total cash. total cash

Child attributes

currencyobjectrequired

currency. currency

Child attributes

settled_cashstringrequired

settled cash. settled cash

available_cashstringrequired

available cash. available cash

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request GET \
  --url 'https://b-api.lbkrs.com/v1/whaleapi/asset/query_total_cash' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "total_cash": {
      "currency": {
        "settled_cash": "125630.50",
        "available_cash": "125630.50"
      }
    }
  }
}