Margin Call Pre - Calculation List

Queries Margin Call Pre - Calculation List data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

task_idstring

Batch No. Filters results by Batch No.

statusstring

Status. Filters results by Status.

1 · Success2 · Failed3 · Pending6 · Success

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Margin Call Pre - Calculation List records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Task ID. Returned value: Unique identifier of the current record.

account_channelstring

Account Channel. Returned value: Account Channel.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

task_idstring

Batch No. Returned value: Batch No.

statusstring

Margin Call Calculate. Returned value: Margin Call Calculate.

status_valstring

Margin Call Calculate (raw value). Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

illiquid_statusstring

Adjusted Loan Balances Calculate. Returned value: Adjusted Loan Balances Calculate.

illiquid_status_valstring

Adjusted Loan Balances Calculate (raw value). Raw value of illiquid_status. The illiquid_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

relate_stocks_countstring

Relate Stocks Count. Returned value: Relate Stocks Count.

holding_userstring

Holding User. Returned value: Holding User.

simulate_margin_call_countstring

Simulate Margin Call Count. Returned value: Simulate Margin Call Count.

est_reduce_hkdstring

Est Reduce. Returned value: Est Reduce.

cal_typestring

Cal Type. Returned value: Cal Type.

cal_type_valstring

Cal Type (raw value). Raw value of cal_type. The cal_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Currency. Returned value: Currency.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_margin_call_simulations' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "7377",
        "account_channel": "lb",
        "created_at": "1776307886",
        "task_id": "8b1123b0-4838-4a9d-99df-49d4d3251872",
        "status": "Failed",
        "status_val": "2",
        "illiquid_status": "0",
        "illiquid_status_val": "0",
        "relate_stocks_count": "16,512",
        "holding_user": "0",
        "simulate_margin_call_count": "4,807",
        "est_reduce_hkd": "770,886,674,288.77",
        "cal_type": "Calculated based on market",
        "cal_type_val": "按市场计算",
        "currency": "HKD"
      }
    ],
    "total": 733
  }
}