Short Margin

Queries Short Margin 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_short_sell_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.short_sell_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.

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

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

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 Short Margin 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.

im_factorstring

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

mm_factorstring

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

fm_factorstring

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

mcm_factorstring

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

availablestring

Lending Pool Qty. Returned value: Lending Pool Qty.

available_valstring

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

fee_ratestring

short-selling interest rate(%). Returned value: short-selling interest rate(%).

short_sell_statusstring

Shortsell Status. Returned value: Shortsell Status.

short_sell_status_valstring

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

auto_close_qty_displaystring

Min Lending Pool Qty Before Forced Buyback. Returned value: Min Lending Pool Qty Before Forced Buyback.

auto_open_qty_displaystring

Min Lending Pool Qty For Supporting Shortsell. Returned value: Min Lending Pool Qty For Supporting Shortsell.

latest_edit_atstring

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

latest_edit_bystring

Updated By. Returned value: Updated By.

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_short_sell_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": "ST/US/IMA",
        "counter_id_val": "",
        "stock_name": "IMAGENEBIO INC.",
        "market": "US",
        "im_factor": "80.00",
        "mm_factor": "60.00",
        "fm_factor": "50.00",
        "mcm_factor": "70.00",
        "available": "100000",
        "available_val": "100000.0000000000",
        "fee_rate": "4.07",
        "short_sell_status": "Short selling allowed",
        "short_sell_status_val": "0",
        "auto_close_qty_display": "",
        "auto_open_qty_display": "",
        "latest_edit_at": "1784166436",
        "latest_edit_by": "user@example.com"
      }
    ],
    "total": 629
  }
}