Service Strategy · Whale Docs

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

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

channel_namestring

Filters results by Exchange Channel.

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

support_currencystring

Filters results by Currency Pair.

change_typestring

Filters results by Exchange Type.

Allowed values:

0 - None
1 - Large Amount Exchange
2 - Small Amount Exchange (within exchange pool)
3 - Small Amount Exchange (beyond exchange pool)

0 · None1 · Large Amount Exchange2 · Small Amount Exchange (within exchange pool)3 · Small Amount Exchange (beyond exchange pool)

service_strategystring

Filters results by Exchange Strategy.

Allowed values:

SINGLE - Channel exchange
BATCH - Pool exchange

SINGLE · Channel exchangeBATCH · Pool exchange

enable_flagstring

Filters results by Status.

Allowed values:

true - Enable
false - Deactivate

true · Enablefalse · Deactivate

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Service Strategy 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.

service_strategystring

Returned value: Exchange Strategy.

service_strategy_valstring

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

is_defaultstring

Returned value: Indicates whether default?.

is_default_valstring

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

enable_flagstring

Returned value: Indicates whether status.

enable_flag_valstring

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

support_currencystring

Returned value: Currency Pair.

service_timestring

Returned value: Service Time. The date or time format follows the value returned by the API.

channel_namestring

Returned value: Exchange Channel.

channel_name_valstring

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

change_typestring

Returned value: Exchange Type.

change_type_valstring

Raw value of change_type. The change_type 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 Time. The date or time format follows the value returned by the API.

deleted_atstring

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "174011",
        "service_strategy": "Pool exchange",
        "service_strategy_val": "BATCH",
        "is_default": "SPECIFIC",
        "is_default_val": "SPECIFIC",
        "enable_flag": "Enable",
        "enable_flag_val": "true",
        "support_currency": "[\"ALL/ALL\"]",
        "service_time": "{\"time_zones\":\"hk_trade_day\",\"time_rule\":\"08:00:00-15:00:00\"}",
        "channel_name": "",
        "channel_name_val": "",
        "change_type": "Small Amount Exchange (beyond exchange pool)",
        "change_type_val": "3",
        "updated_at": "1784183794",
        "deleted_at": ""
      }
    ],
    "total": 3
  }
}

Export

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

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

Export options Export records Download result