Skip to content
Longport WhaleLongport Whale
SBL Overview

Short Sell Position Overview

Queries Short Sell Position Overview data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/holding_short_sell_stock_holding_summaries

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.short_sell_stock_holding_summary

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
counter_idstring

Stock Code. Filters results by Stock Code.

marketstring

Market. Filters results by Market.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: US, HK, CN, SG, VAHK, CNHK

USHKCNSGVAHKCNHK

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Short Sell Position Overview records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
counter_idstring

Stock Code. Returned value: Stock Code.

counter_id_valstring

Stock Code (raw value). Raw value of counter_id. The counter_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

marketstring

Market. Returned value: Market.

market_valstring

Market (raw value). Raw value of market. The market field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_namestring

Securities Name. Returned value: Securities Name.

availablestring

SBL Quantity (IB). Returned value: SBL Quantity (IB).

client_countstring

No of Clients with Holdings. Returned value: No of Clients with Holdings.

totalstring

Total Holding Qty. Returned value: Total Holding Qty.

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Remarks. Returned value: Remarks.

totalintegerrequired

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