Query Currency Pairs

Query the "Currency Pairs" configuration list. All filter fields are optional; sending an empty object or omitting a field returns every currency-pair configuration.

Request parameters

created_at: Filter by creation time. When omitted, no filtering is applied on this field.
from_currency: Filter by the debit (source) currency. When omitted, no filtering is applied on this field.
to_currency: Filter by the credit (target) currency. When omitted, no filtering is applied on this field.

Result

On success, data.support_currency_resp returns the currency-pair configuration records grouped by source currency. See the 200 response fields for the meaning of each field.

POSThttps://b-api.longbridge.xyz/forex/query_support_currency

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

created_atstring

Filters by creation time. The value is a comma-joined date range start,end, e.g. 2026-07-01,2026-07-01.

When omitted, no filtering is applied on this field.

from_currencystring

Filters by the debit (source) currency, given as a three-letter currency code.

When omitted, no filtering is applied on this field.

USD · USDHKD · HKDSGD · SGDCNY · CNYAUD · AUDJPY · JPYGBP · GBPEUR · EURCAD · CADMYR · MYRAMD · AMDBGN · BGNBTN · BTNBWP · BWPBZD · BZDCDF · CDFCHF · CHFDKK · DKKGHS · GHSGMD · GMDGNF · GNFHRK · HRKHUF · HUFILS · ILSINR · INRIQD · IQDIRR · IRRISK · ISKLRD · LRDLYD · LYDMOP · MOPRUB · RUBUAH · UAHUGX · UGXUYI · UYIUYU · UYUUZS · UZSXAF · XAFXOF · XOFXSU · XSUYER · YERIDR · IDRTWD · TWDTHB · THBKRW · KRWNZD · NZD

to_currencystring

Filters by the credit (target) currency, given as a three-letter currency code.

When omitted, no filtering is applied on this field.

Responses

HTTP 200The request was processed successfully. data.support_currency_resp is the list of currency-pair configuration records grouped by source currency.

Standard response envelopecodemessagedata

dataobjectdata structure

support_currency_resparray<object>required

Returned value: List of currency-pair configuration records matching the query conditions, grouped by source currency. Each item represents one source currency and all of its target currencies.

Child attributes

from_currencystring

Returned value: Debit (source) currency, a three-letter currency code.

to_currencystring

Returned value: The target-currency configuration under this source currency, provided as a JSON-encoded string. When parsed, it is an object whose id_to_ccy field is an array of target currencies. Each array item contains:

id: Unique identifier of this "source-target" record, used for editing or deletion.
to_ccy: Credit (target) currency, a three-letter currency code.
default_currency: Whether this is the default target currency for the source currency; true means default.

created_atstring

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

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 --request POST \
  --url 'https://b-api.longbridge.xyz/forex/query_support_currency' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "from_currency": "USD",
  "to_currency": "HKD",
  "created_at": "2026-07-01,2026-07-01"
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "support_currency_resp": [
      {
        "from_currency": "USD",
        "to_currency": "{\"id_to_ccy\":[{\"id\":\"1001\",\"to_ccy\":\"HKD\",\"default_currency\":true},{\"id\":\"1002\",\"to_ccy\":\"JPY\",\"default_currency\":false}]}",
        "created_at": "1780480167"
      },
      {
        "from_currency": "HKD",
        "to_currency": "{\"id_to_ccy\":[{\"id\":\"1003\",\"to_ccy\":\"USD\",\"default_currency\":true}]}",
        "created_at": "1780480200"
      }
    ]
  }
}