Agent Billing · Whale Docs

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

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

custodian_idstring

Filters results by Broker.

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

billing_item_idstring

Filters results by Item ID.

name_codestring

Filters results by Fee Type.

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

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Agent Billing 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

custodian_idstring

Returned value: Broker.

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.

special_fee_cntstring

Returned value: Conditional Charges Qty.

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.

basisstring

Returned value: Market/ Currency.

name_idstring

Returned value: Fee Type.

name_id_valstring

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

metric_typestring

Returned value: Metric Type.

metric_type_valstring

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

currencystring

Returned value: Currency.

fee_ratestring

Returned value: Fee Rate.

minstring

Returned value: Min Fee.

maxstring

Returned value: Max Fee.

billing_item_idstring

Returned value: Item ID.

directionstring

Returned value: Direction.

direction_valstring

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

coefficientstring

Returned value: Coefficient.

granularitystring

Returned value: Fee Granularity.

granularity_valstring

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

cutoff_methodstring

Returned value: Rounding Method.

cutoff_method_valstring

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

cutoff_digitsstring

Returned value: Rounding (Decimals).

basis_typestring

Returned value: Basis Type.

basis_type_valstring

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

thresholdstring

Returned value: Threshold.

max_metric_ratestring

Returned value: Can Be More Than Trade Amt * Rate.

updated_atstring

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

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.

idstring

Returned value: Unique identifier of the current record.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "custodian_id": "CCASS",
        "custodian_id_val": "1",
        "special_fee_cnt": "3",
        "biz_type": "Broker Fee- Stock Trade",
        "biz_type_val": "11",
        "basis": "US",
        "name_id": "Commission",
        "name_id_val": "6031",
        "metric_type": "Transaction Amount/Other Amount",
        "metric_type_val": "2",
        "currency": "CNH",
        "fee_rate": "0 < x <= 3500: 0.044\\n3500 < x <= 4000: 0.104\\n4000 < x <= ∞: 0.021",
        "min": "2.1",
        "max": "2000002",
        "billing_item_id": "10288",
        "direction": "Match All",
        "direction_val": "3",
        "coefficient": "1",
        "granularity": "Order",
        "granularity_val": "2",
        "cutoff_method": "Round",
        "cutoff_method_val": "1",
        "cutoff_digits": "2",
        "basis_type": "Market",
        "basis_type_val": "1",
        "threshold": "0",
        "max_metric_rate": "",
        "updated_at": "1763697503",
        "state": "Enabled",
        "state_val": "2",
        "id": "335469"
      }
    ],
    "total": 621
  }
}

Export

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

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

Export options Export records Download result