Skip to content
Longport WhaleLongport Whale
Short Margin Ratio

Short Margin Record

Query short-sell security margin-ratio change records, used to track the history of adjustments to each security's short-sell margin ratios and short-sell parameters.

Request parameters

  • Combine business filters through filters (optional fields are documented under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Records are kept per security, including the security code counter_id, security name, and market market.

  • Each record stores that security's initial margin ratio im_factor, maintenance margin ratio mm_factor, force-liquidation margin ratio fm_factor, and MarginCall margin ratio mcm_factor (all as percentages).

  • It also includes the borrowable pool quantity available, the short-sellable status short_sellable, and short-sell control parameters such as the auto-close and auto-resume short-sell quantities.

  • Each record carries the change time, the operator operator, and a remark, and is typically used by risk-control staff to audit the history of short-sell margin-ratio adjustments.

Returns

On success, returns the list of matching records with pagination info. See the response definition for the meaning of each column.

POSThttps://b-api.lbkrs.com/v1/datasets/instrument_short_sell_stock_margin_ratio_changes

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_ratio.short_sell_margin_ratio_query

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

Request body application/json

filtersobject

Filters

Child attributes
counter_idstring

Stock Code. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

marketstring

Market

Allowed values: US US market, HK Hong Kong market, UK UK market, SH Shanghai market, SZ Shenzhen market, SG Singapore market, KR Korea market, JP Japan market, AU Australia market, DE Germany market, CA Canada market, TH Thailand market, ID Indonesia market, MY Malaysia market, TR Turkey market, NA Unknown market, OSL, HAS, EU Europe market, UT, GTMMF

Values
US
HK
UK
SH
SZ
SG
KR
JP
AU
DE
CA
TH
ID
MY
TR
NA
OSL
HAS
EU
UT
GTMMF
pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

counter_idstring

Stock Code

counter_id_valstring

Stock Code (raw value). Raw value behind field counter_id: counter_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

stock_namestring

Stock Name

marketstring

Market

market_valstring

Market (raw value). Raw value behind field market: market returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

im_factorstring

Shortsell IM Factor (%)

mm_factorstring

Shortsell MM Factor (%)

fm_factorstring

Shortsell FM Factor (%)

mcm_factorstring

Shortsell Margin Call Factor (%)

availablestring

Lending Pool Qty

short_sellablestring

Shortsell Status

short_sellable_valstring

Shortsell Status (raw value). Raw value behind field short_sellable: short_sellable returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

auto_close_qty_displaystring

Min Lending Pool Qty Before Forced Buyback

auto_open_qty_displaystring

Min Lending Pool Qty For Supporting Shortsell

created_atstring

Updated At

operatorstring

Processed By

remarkstring

Remarks

remark_valstring

Remarks (raw value). Raw value behind field remark: remark returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired

Total

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