Trading Market · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_markets

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

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

marketstring

Filters results by Market.

Values are dynamic. Call GET /v1/datasets/refs/clearing_markets_all to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

idstring

Filters results by Id.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Trading Market records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

marketstring

Returned value: Market.

otc_flagstring

Returned value: Day-End Tasks Type.

otc_flag_valstring

Raw value of otc_flag. The otc_flag field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

busin_flow_namestring

Returned value: Market Group.

overnight_flagstring

Returned value: Overnight Tag.

overnight_flag_valstring

Raw value of overnight_flag. The overnight_flag field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

equity_back_nstring

Returned value: Stock Settlement T+N.

balance_back_nstring

Returned value: Cash Settlement T+N.

custodian_idstring

Returned value: Custodian (Default).

custodian_id_valstring

Raw value of custodian_id. The custodian_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

sub_position_nostring

Returned value: Sub A/C(Default).

currencystring

Returned value: Currency.

use_public_stock_infostring

Returned value: Sources of Symbol Information.

use_public_stock_info_valstring

Raw value of use_public_stock_info. The use_public_stock_info field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

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

updated_bystring

Returned value: Updated By.

totalintegerrequired

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/clearing_markets' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "market": "US",
        "otc_flag": "Normal Day-End Tasks",
        "otc_flag_val": "0",
        "busin_flow_name": "欧美市场",
        "overnight_flag": "Yes",
        "overnight_flag_val": "1",
        "equity_back_n": "1",
        "balance_back_n": "1",
        "custodian_id": "IB",
        "custodian_id_val": "2",
        "sub_position_no": "U60265141",
        "currency": "USD",
        "use_public_stock_info": "Dependent On Public Stock Information",
        "use_public_stock_info_val": "1",
        "updated_at": "1784010321",
        "updated_by": "user@example.com"
      }
    ],
    "total": 26
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_markets/download

Export options Export records Download result