Skip to content
Longport WhaleLongport Whale
Short Margin Ratio

Short Margin Record

Query the Short Margin Record.

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

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

lb_hk_margin_ratio.short_sell_margin_ratio_query

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

Query parameters

filtersobject

Filters

Child attributes
counter_idstring

Stock Code

marketstring

Market

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

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