Skip to content
Longport WhaleLongport Whale
Client Short Margin

Client Short Margin Change Record

Query the change history of clients' short (short-sell) stock margin ratios, used by risk control to trace every adjustment of short-sell margin parameters.

Request parameters

  • Combine business filters through filters (optional fields are listed in the filters field notes below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

  • The data comes from the change log of client short-stock margin ratios; each record represents one change to a client's short-sell margin configuration on a given security.

  • Each record carries client details (member_id, aaid account number, account_type, account_mark, account_channel, client-group name), security details (counter_id, stock name, market), and the initial margin im_factor, maintenance margin mm_factor, forced-liquidation margin fm_factor, and margin-call margin mcm_factor (all percentages).

  • It also includes the short-sell status, the auto-close and auto-resume quantity thresholds, status, remark, and the created, updated, and expiry timestamps, supporting audit of short-sell credit changes over time.

Returns

On success, returns the matching record list with pagination. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_ratio.account_short_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
member_idstring

Member ID

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

statusstring

Status

Allowed values: 0 Active, 1 Invalidated

Values
0
1
account_typestring

Account Type

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

Values
M
C
F
markstring

Account Tag

Allowed values: dt Day Trade

Values
dt
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
member_idstring

Member ID

member_id_valstring

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

member_real_namestring

Name

aaidstring

A/C No

aaid_valstring

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

account_typestring

A/C Type

account_type_valstring

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

account_markstring

Account Tag

account_mark_valstring

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

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

IM Factor (%)

mm_factorstring

MM Factor (%)

fm_factorstring

FM Factor (%)

mcm_factorstring

Margin Call Factor (%)

statusstring

Status

status_valstring

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

updated_atstring

Updated At

created_atstring

Submitted At

expire_atstring

Expiry Date

auto_close_qty_displaystring

Min Lending Pool Qty Before Forced Buyback

auto_open_qty_displaystring

Min Lending Pool Qty For Supporting Shortsell

remarkstring

Remark

remark_valstring

Remark (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.

short_sell_statusstring

Shortsell Status

short_sell_status_valstring

Shortsell Status (raw value). Raw value behind field short_sell_status: short_sell_status 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