Skip to content
Longport Whale
Reference Exchange Rate

Reference Exchange Rate Export

Export the Reference Exchange Rate list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of atm_forex_ib_rates.yaml (the query capability).

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

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Whale Docs