Skip to content
Longport WhaleLongport Whale
Client Stock Margin

Client Margin Change Record Query

Query per-account security margin-ratio change records, used to track the history of margin ratios customized for a client account on specific securities.

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 client-account and security, including the client member_id, name, securities account aaid, account type account_type, account mark account_mark, and counter channel, plus the security code counter_id, stock name, and market market.

  • Each record stores that client'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) on that security.

  • It also includes the status status, expiry date expire_at, update time, operator operator, and a remark.

  • Typically used by risk-control staff to audit the customization and change history of a specific client's per-security margin ratios.

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/account_stock_margin_ratio_changes

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_ratio.account_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
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
idstring

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

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

expire_atstring

Expiry Date

remarkstring

Remark

operatorstring

Processed By

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