Reference Exchange Rate

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_forex_ib_rates

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.idstring

Ref Conversion Rate ID

filters.base_currencystring

Base Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.other_currencystring

Conversion Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.record_dateobject

Record Date. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.record_date.gtestring

Greater Than or Equal

filters.record_date.ltestring

Less Than or Equal

filters.dtstring

Ledger Date

filters.updated_atobject

Updated Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded). Defaults to the range [6 day(s) ago, today] when omitted (gte/lte roll with the request date).

Child attributes

filters.updated_at.gtestring

Greater Than or Equal

filters.updated_at.ltestring

Less Than or Equal

filters.rate_typestring

Rate Type. Options: ACCOUNT = Ledger rate; CCASS = CCASS; CURRENT = Spot rate

ACCOUNTCCASSCURRENT

filters.sourcestring

Source. Options: FILE = FILE; MANUEL_CREATE = MANUEL CREATE; AUTO = AUTO; COPY = COPY; CCASS = Auto Follow HKEX

FILEMANUEL_CREATEAUTOCOPYCCASS

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_forex_ib_rates' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "source": "<string>",
        "rate_type": "<string>",
        "custom_channel_from": "<string>",
        "other_currency": "<string>",
        "base_currency": "<string>",
        "bid_rate": "<string>",
        "offer_rate": "<string>",
        "average_rate": "<string>",
        "record_date": "<string>",
        "dt": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "action_user": "<string>"
      }
    ],
    "total": 0
  }
}