Skip to content
Longport WhaleLongport Whale
Reference Exchange Rate

Reference Exchange Rate

Queries Reference Exchange Rate data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

Authorizationstringheaderlb_hk_conversion.forex_ib_ratesRequired

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
idstring

Ref Conversion Rate ID. Filters results by Ref Conversion Rate ID.

base_currencystring

Base Currency. Filters results by Base Currency.

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

other_currencystring

Conversion Currency. Filters results by Conversion Currency.

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

record_dateobject

Record Date. Filters results by Record Date.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

dtstring

Ledger Date. Filters results by Ledger Date.

updated_atobject

Updated Time. Filters results by Updated Time.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

rate_typestring

Rate Type. Filters results by Rate Type.

Allowed values: ACCOUNT (Ledger rate), CCASS, CURRENT (Spot rate)

ACCOUNTCCASSCURRENT

sourcestring

Source. Filters results by Source.

Allowed values: FILE, MANUEL_CREATE (MANUEL CREATE), AUTO, COPY, CCASS (Auto Follow HKEX)

FILEMANUEL_CREATEAUTOCOPYCCASS

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Reference Exchange Rate records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Ref Conversion Rate ID. Returned value: Unique identifier of the current record.

sourcestring

Source. Returned value: Source.

source_valstring

Source (raw value). Raw value of source. The source field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

rate_typestring

Rate Type. Returned value: Rate Type.

rate_type_valstring

Rate Type (raw value). Raw value of rate_type. The rate_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_channel_fromstring

Exchange Channel. Returned value: Exchange Channel.

other_currencystring

Conversion Currency. Returned value: Conversion Currency.

other_currency_valstring

Conversion Currency (raw value). Raw value of other_currency. The other_currency field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

base_currencystring

Base Currency. Returned value: Base Currency.

base_currency_valstring

Base Currency (raw value). Raw value of base_currency. The base_currency field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bid_ratestring

Bid Rate. Returned value: Bid Rate.

offer_ratestring

Offer Rate. Returned value: Offer Rate.

average_ratestring

Average Rate. Returned value: Average Rate.

record_datestring

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

dtstring

Ledger Date. Returned value: Ledger Date.

created_atstring

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

updated_atstring

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

action_userstring

Action User. Returned value: Action User.

totalintegerrequired

Total. 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

Whale Docs