Batch and Auto Close Position Record

Queries Batch and Auto Close Position Record 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_batch_force_close_logs

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

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

created_atobject

Created At. Filters results by Created At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

aaidstring

Client. Filters results by Client.

order_idstring

Order Id. Filters results by Order Id.

risk_monitoring_log_idstring

Risk Monitoring Log Id. Filters results by Risk Monitoring Log Id.

force_typestring

Force Type. Filters results by Force Type.

force · Forcebatch_force · BatchForce

typestring

Reason. Filters results by Reason.

0 · Margin Call1 · Call Back

counter_idstring

Counter ID. Filters results by Counter ID.

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 Batch and Auto Close Position Record 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

risk_monitoring_log_idstring

Risk Monitoring Log Id. Returned value: Risk Monitoring Log Id.

created_atstring

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

aaidstring

Aaid. Returned value: Aaid.

aaid_valstring

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

account_channelstring

Account Channel. Returned value: Account Channel.

order_typestring

OrderType. Returned value: OrderType.

order_type_valstring

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

order_idstring

Order Id. Returned value: Order Id.

order_id_valstring

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

counter_idstring

Counter Id. Returned value: Counter Id.

counter_id_valstring

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

stock_namestring

Stock Name. Returned value: Stock Name.

submitted_pricestring

Submitted Price. Returned value: Submitted Price.

submitted_quantitystring

Submitted Quantity. Returned value: Submitted Quantity.

executed_pricestring

Executed Price. Returned value: Executed Price.

executed_quantitystring

Executed Quantity. Returned value: Executed Quantity.

statestring

State. Returned value: State.

state_valstring

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

actionstring

Action. Returned value: Action.

action_valstring

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

op_userstring

Op User. Returned value: Op User.

position_sidestring

Position Side. Returned value: Position Side.

position_side_valstring

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

force_typestring

Force Type. Returned value: Force Type.

force_type_valstring

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

typestring

Reason. Returned value: Reason.

type_valstring

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

security_typestring

Security Type. Returned value: Security Type.

security_type_valstring

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

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_batch_force_close_logs' \
  --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": [
      {
        "risk_monitoring_log_id": "0",
        "created_at": "1784183258",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "account_channel": "lb",
        "order_type": "Enhanced Limit",
        "order_type_val": "ELO",
        "order_id": "1262294489540616192",
        "order_id_val": "",
        "counter_id": "ST/HK/1211",
        "counter_id_val": "",
        "stock_name": "比亚迪股份",
        "submitted_price": "90.9",
        "submitted_quantity": "800",
        "executed_price": "0",
        "executed_quantity": "0",
        "state": "Canceled Status",
        "state_val": "CanceledStatus",
        "action": "Buy",
        "action_val": "1",
        "op_user": "system",
        "position_side": "Short",
        "position_side_val": "1",
        "force_type": "BatchForce",
        "force_type_val": "batch_force",
        "type": "Margin Call",
        "type_val": "0",
        "security_type": "Stocks",
        "security_type_val": "CS"
      }
    ],
    "total": 11131
  }
}