Client Short Stock Margin

Queries Client Short Stock 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/account_stock_short_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

margin_ratio.account_short_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

member_idstring

Member ID. Filters results by Member ID.

statusstring

Status. Filters results by Status.

0 · Active1 · Expired

account_typestring

Account Type. Filters results by Account Type.

M · MarginC · CashF · Futures

markstring

Account Tag. Filters results by Account Tag.

dt · Day Trade

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 Client Short Stock 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

member_idstring

Member ID. Returned value: Member ID.

member_id_valstring

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

member_real_namestring

Name. Returned value: Name.

aaidstring

A/C No. Returned value: A/C No.

aaid_valstring

A/C No (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_typestring

A/C Type. Returned value: A/C Type.

account_type_valstring

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

account_markstring

Account Tag. Returned value: Account Tag.

account_mark_valstring

Account Tag (raw value). Raw value of account_mark. The account_mark 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 (%).

statusstring

Status. Returned value: Status.

status_valstring

Status (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.

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.

expire_atstring

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

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.

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.

remarkstring

Remark. Returned value: Remark.

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/account_stock_short_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": [
      {
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "member_real_name": "示例用户",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "account_type": "Margin",
        "account_type_val": "M",
        "account_mark": "Day Trade",
        "account_mark_val": "dt",
        "counter_id": "ST/US/IMA",
        "counter_id_val": "",
        "stock_name": "IMAGENEBIO INC.",
        "market": "US",
        "market_val": "US",
        "im_factor": "45.00",
        "mm_factor": "35.00",
        "fm_factor": "30.00",
        "mcm_factor": "40.00",
        "status": "Active",
        "status_val": "0",
        "updated_at": "1784166336",
        "created_at": "1784166336",
        "expire_at": "1786758335",
        "auto_close_qty_display": "--",
        "auto_open_qty_display": "--",
        "available": "100000",
        "available_val": "100000.0000000000",
        "fee_rate": "4.07",
        "short_sell_status": "Short selling is prohibited",
        "short_sell_status_val": "0",
        "remark": "auto_test"
      }
    ],
    "total": 5072
  }
}