Fee Scenario Text · Whale Docs

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

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

tabstring

Filters results by Tab (market tab).

The candidate values change dynamically. Call GET /v1/billing/myrates/markets to retrieve the currently available tabs, and use the returned tabs[].tab as this field's value (e.g. HK, US, US_OPTIONS, HAS).

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Fee Scenario Text 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

billing_item_idstring

Returned value: Fee Type.

billing_item_id_valstring

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

biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

contentstring

Returned value: Content.

remarkstring

Returned value: Remark.

merchantstring

Returned value: Merchant.

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.

makerstring

Returned value: Maker.

updated_atstring

Returned value: Last Updated. 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_item_copywritings' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "billing_item_id": "{\"zh-CN\":\"消费税\",\"zh-HK\":\"消費稅\",\"en\":\"GST\"}",
        "billing_item_id_val": "32338",
        "biz_type": "Options Trade",
        "biz_type_val": "5",
        "content": "{\"en\": \"en_content_期权交易_CA_OPTIONS_GST\", \"zh-CN\": \"zh-CN_content_期权交易_CA_OPTIONS_消费税\", \"zh-HK\": \"zh-HK_content_期权交易_CA_OPTIONS_消費稅\"}",
        "remark": "{\"en\": \"en_remark_期权交易_CA_OPTIONS_GST\", \"zh-CN\": \"zh-CN_remark_期权交易_CA_OPTIONS_消费税\", \"zh-HK\": \"zh-HK_remark_期权交易_CA_OPTIONS_消費稅\"}",
        "merchant": "{\"en\": \"en_merchant_期权交易_CA_OPTIONS_GST\", \"zh-CN\": \"zh-CN_merchant_期权交易_CA_OPTIONS_消费税\", \"zh-HK\": \"zh-HK_merchant_期权交易_CA_OPTIONS_消費稅\"}",
        "state": "Off",
        "state_val": "2",
        "maker": "user@example.com",
        "updated_at": "1767757289"
      }
    ],
    "total": 313
  }
}

Export

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

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

Export options Export records Download result