Skip to content
Longport WhaleLongport Whale
Custom Data

Custom Data Details

Query the Simulate_file_details list.

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

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_call.risk_monitoring_simulation_list_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

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.

advance_declinestring

Advance Decline(%)

im_ratiostring

Long Im Ratio(%)

mcm_ratiostring

Long Mcm Ratio(%)

mm_ratiostring

Long Mm Ratio(%)

fm_ratiostring

Long Fm Ratio(%)

allow_short_sellstring

Allow ShortsSell

allow_short_sell_valstring

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

short_im_ratiostring

Short Im Ratio(%)

short_mcm_ratiostring

Short Mcm Ratio(%)

short_mm_ratiostring

Short Mm Ratio(%)

short_fm_ratiostring

Short Fm Ratio (%)

option_im_max_limit_ratiostring

Option Im Max Limit Ratio(%)

option_im_min_limit_ratiostring

Option Im Min Limit Ratio(%)

option_mm_max_limit_ratiostring

Option Mm Max Limit Ratio(%)

option_mm_min_limit_ratiostring

Option Mm Min Limit Ratio(%)

option_fm_max_limit_ratiostring

Option Fm Max Limit Ratio(%)

option_fm_min_limit_ratiostring

Option Fm Min Limit Ratio(%)

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