Ratio Setup Records

Queries Adjust Stock Margin Rate Task 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/instrument_stock_margin_ratio_tasks

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

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

counter_idstring

Stock Code. Filters results by Stock Code.

marketstring

Market. Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

operation_dateobject

Processed At. Filters results by Processed 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.

remarkstring

Remarks. Filters results by Remarks.

trigger_statusstring

Setup Status. Filters results by Setup Status.

0 · Not Triggered1 · Triggered2 · Cancelled

sourcestring

Source. Filters results by Source.

stock margin ratio · Stock Margin Factordaytrade margin ratio · Day Trade Factor

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 Adjust Stock Margin Rate Task 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.

trigger_statusstring

Setup Status. Returned value: Setup Status.

trigger_status_valstring

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

sourcestring

Source. Returned value: Source.

source_valstring

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

counter_idstring

Stock Code. Returned value: Stock Code.

counter_id_valstring

Stock Code (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.

marketstring

Market. Returned value: Market.

market_valstring

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

im_factorstring

IM Factor (%). Returned value: IM Factor (%).

mm_factorstring

MM Factor (%). Returned value: MM Factor (%).

fm_factorstring

FM Factor (%). Returned value: FM Factor (%).

mcm_factorstring

Margin Call Factor (%). Returned value: Margin Call Factor (%).

trigger_atstring

Effective Date. Returned value: Effective Date. The date or time format follows the value returned by the API.

operatorstring

Processed By. Returned value: Processed By.

remarkstring

Remarks. Returned value: Remarks.

updated_atstring

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

created_atstring

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

operation_datestring

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

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/instrument_stock_margin_ratio_tasks' \
  --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": "84808",
        "trigger_status": "Triggered",
        "trigger_status_val": "1",
        "source": "Day Trade Factor",
        "source_val": "daytrade margin ratio",
        "counter_id": "ST/US/IMA",
        "counter_id_val": "",
        "stock_name": "IMAGENEBIO INC.",
        "market": "US",
        "market_val": "US",
        "im_factor": "98.00",
        "mm_factor": "76.54",
        "fm_factor": "63.24",
        "mcm_factor": "85.67",
        "trigger_at": "2026-07-17 09:47:15",
        "operator": "user@example.com",
        "remark": "Batch adjust",
        "updated_at": "1784166439",
        "created_at": "1784166438",
        "operation_date": "1784166439"
      }
    ],
    "total": 27072
  }
}