Query Total Holdings

Returns the full stock-holding data for the account.

Request parameters

This endpoint has no required parameters; no additional parameters need to be supplied.

Business notes

Keyed by security, it returns each security's long positions long_stock and short positions short_stock, with settled quantity settled_quantity and available quantity available_quantity per security.

Returns

On success, returns the full stock-holding data. See the response definition for field meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance.stock

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

long_stockobjectrequired

long stock. long stock

Child attributes

symbolobjectrequired

security underlying. security underlying

Child attributes

settled_quantitystringrequired

settled quantity. settled quantity

available_quantitystringrequired

available quantity. available quantity

short_stockobjectrequired

short stock. short stock

Child attributes

symbolobjectrequired

security underlying. security underlying

Child attributes

settled_quantitystringrequired

settled quantity. settled quantity

available_quantitystringrequired

available quantity. available quantity

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_holdings' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "long_stock": {
      "symbol": {
        "settled_quantity": "1200",
        "available_quantity": "1200"
      }
    },
    "short_stock": {
      "symbol": {
        "settled_quantity": "1200",
        "available_quantity": "1200"
      }
    }
  }
}