Order Merging Rule · Whale Docs

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

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.

Allowed values: HK, US, SZ, SH, SG

HK · HKUS · USSZ · SZSH · SHSG · SG

idstring

Filters results by Rule ID.

namestring

Filters results by Rule Name.

statestring

Filters results by State.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

0 - Effective
2 - Not Effective

0 · Effective2 · Not Effective

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Order Merging Rule 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

idstring

Returned value: Unique identifier of the current record.

namestring

Returned value: Rule Name.

marketstring

Returned value: Market.

statestring

Returned value: State.

state_valstring

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

operatorstring

Returned value: Operator.

operator_valstring

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

created_atstring

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

updated_atstring

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

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "23853",
        "name": "434",
        "market": "US",
        "state": "Effective",
        "state_val": "0",
        "operator": "示例用户",
        "operator_val": "user@example.com",
        "created_at": "1759129131",
        "updated_at": "1759129300"
      }
    ],
    "total": 142
  }
}

Export

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

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

Export options Export records Download result