Stock Margin Rate

Queries Stock Margin Rate 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_ratios

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

counter_idstring

Stock Code. Filters results by Stock Code.

marketstring

Market. Filters results by Market.

/US/ · US/HK/ · HK

stock_statusstring

Trading Status. Filters results by Trading Status.

0 · Active1 · Error/ Invalid2 · Suspended/Delisted

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 Stock Margin Rate 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

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.

stock_statusstring

Trading Status. Returned value: Trading Status.

stock_status_valstring

Trading Status (raw value). Raw value of stock_status. The stock_status 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 (%).

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.

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_ratios' \
  --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": [
      {
        "counter_id": "ETF/US/YANG",
        "counter_id_val": "",
        "stock_name": "DIREXION DAILY FTSE CHINA BEAR 3X ETF",
        "market": "US",
        "market_val": "US",
        "stock_status": "Active",
        "stock_status_val": "0",
        "im_factor": "100.00",
        "mm_factor": "60.00",
        "fm_factor": "55.00",
        "mcm_factor": "62.00",
        "updated_at": "1779951429",
        "created_at": "1725868805"
      }
    ],
    "total": 905
  }
}