Skip to content
Longport WhaleLongport Whale
Assets Overview

Equity Holding Summary

Returns the holding summary under the asset overview for a given asset type.

Request parameters

  • Required: equity_type (asset type)
  • Optional: client_types (client type), account_types (account type), broker_codes (broker), page (page number), page_size (page size)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

equity_type selects the asset class to summarize. client_types, account_types, and broker_codes filter the result; join multiple values with a comma ,, and omit a filter to leave that dimension unfiltered.

Returns

On success, returns the holding-summary list for the asset type with pagination info. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/portfolio/query_equity_holding_summary

Authorization

AuthorizationstringheaderRequired

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

Permission

asset.summary_query

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

Request body application/json

client_typesstring

Client Type. Client type.

  • Join multiple values with a comma ,
  • Omit this parameter to query all client types
  • Example: 1,2

Allowed values: 1 Personal Client, 2 Corporate Client, 3 Joint Client

Values
1
Personal Client
2
Corporate Client
3
Joint Client
account_typesstring

Account Type. Account type.

  • Join multiple values with a comma ,
  • Omit this parameter to query all account types
  • Example: M,C

Note: An invalid combination of account type and equity_type (for example, futures account F with fund FUND ) returns 400.

Allowed values: M Margin account, C Cash account, F Futures account

Values
M
Margin
C
Cash
F
Futures
broker_codesstring

AE. Filter by broker (AE) code.

  • Join multiple values with a comma ,
  • Omit this parameter to query all brokers
  • = means unassigned
  • Example: =,LBtestwbwhale123

Query the complete AE code list through GET /v1/datasets/refs/broker_accounts. Values vary by tenant and environment.

Values currently documented:

Values
=
Unassigned
equity_typestringrequired

Asset-type filter for the holding summary. Only one value is supported.

Allowed values: STOCK Stock, OPTION Option, FUND Fund, BOND Bond, MMF MMF, OTC Other, CRYPTO Crypto, WM OTC Derivatives

Values
STOCK
Stock
OPTION
Option
FUND
Fund
BOND
Bond
MMF
MMF
OTC
Other
CRYPTO
Crypto
WM
OTC Derivatives
pagenumber

Page number to query, starting from 1.

page_sizenumber

Page Size. Maximum number of records to return per page. Use a positive integer.

Responses

HTTP 200The request was processed successfully. data contains total_holdings, page, page_size, total_page, total.
Standard response envelopecodemessagedata
dataobjectdata structure
total_holdingsarray<object>

Holdings. Returned value: List of holdings.

Child attributes
counter_idstring

Counter ID. Returned value: Counter ID.

equity_typestring

Asset type. Values are the same as the request parameter equity_type.

Values
STOCK
Stock
OPTION
Option
FUND
Fund
BOND
Bond
MMF
MMF
OTC
Other
CRYPTO
Crypto
WM
OTC Derivatives
counter_namestring

Symbol Name. Localized name, returned per Accept-Language.

total_quantitystring

Holding Quantity. Returned value: Holding Quantity.

last_donestring

Closing Price. Returned value: Closing Price.

market_valuestring

Holding Market Value. Returned value: Holding Market Value.

settledstring

Settled. Returned value: Settled.

unsettlestring

Outstanding. Returned value: Outstanding.

trade_0string

T+0 quantity to be settled. Returned value: T+0 quantity to be settled.

trade_1string

T+1 quantity to be settled. Returned value: T+1 quantity to be settled.

trade_2string

T+2 quantity to be settled. Returned value: T+2 quantity to be settled.

trade_nstring

T+N quantity to be settled. Returned value: T+N quantity to be settled.

symbolstring

Symbol. Instrument code; empty for some holdings.

currencystring

Currency. Returned value: Currency code of the holding, e.g. HKD or USD.

pagenumber

Page. Returned value: Current page number.

page_sizenumber

Page Size. Returned value: Number of records per page in this response.

total_pagenumber

Total Pages. Returned value: Total number of result pages.

totalnumber

Total. Returned value: Total number of matching records, used for pagination.

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

Whale Docs