Exchange Rate Configuration

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

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.

spread_modestring

Filters results by Spread Setup.

Allowed values:

VALUE - Value
RATE - Ratio

VALUE · ValueRATE · Ratio

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Exchange Rate Configuration 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: Service Policy.

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.

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.

from_currencystring

Returned value: Debit Currency.

from_currency_valstring

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

to_currencystring

Returned value: Credit Currency.

to_currency_valstring

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

spread_modestring

Returned value: Spread Setup.

spread_mode_valstring

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

spread_valuestring

Returned value: Transaction Spread.

effective_timestring

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

updated_atstring

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

action_userstring

Returned value: Action User.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "209675",
        "service_strategy": "Channel exchange",
        "service_strategy_val": "SINGLE",
        "channel_name": "HSB",
        "channel_name_val": "HSB",
        "from_currency": "HKD",
        "from_currency_val": "HKD",
        "to_currency": "USD",
        "to_currency_val": "USD",
        "spread_mode": "Ratio",
        "spread_mode_val": "RATE",
        "spread_value": "0-10000HKD,5;",
        "effective_time": "Long-term effectiveness",
        "updated_at": "1784169178",
        "action_user": "user@example.com"
      }
    ],
    "total": 39
  }
}

Export

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

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

Export options Export records Download result