Skip to content
Longport WhaleLongport Whale
Reference Exchange Rate

Create Reference Exchange Rate

Create a reference exchange-rate record, registering the bid, offer, and mid rates for a given channel, currency pair, and record date.

Request parameters

  • Required: channel_name (rate channel), source_from (rate source), base_currency (base currency), other_currency (counter currency), record_date (record date), bid_rate (bid rate), offer_rate (offer rate), average_rate (mid rate)
  • Optional: audit_frontend_resource (audit context)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Reference rates feed downstream FX calculations; verify the currency pair and rate values.

Result

On success the operation completes; refer to the 200 response for the resulting state and data.

POSThttps://b-api.lbkrs.com/forex/rate/create

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.forex_ib_rates

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

channel_namestringrequired

Channel Name. Channel / rate type, an enumerated value; for multi-select they are joined into a comma-separated string.

Allowed values: MANUAL_CURRENT (Spot rate), MANUAL_ACCOUNT (Ledger rate), CCASS

Values
MANUAL_CURRENT
MANUAL_ACCOUNT
CCASS
source_fromstringrequired

Rate Source From. Rate source, single-select, e.g. SINGLE (a single currency pair).

Values
CCASS
Auto Follow HKEX
SINGLE
Single Transaction Add
base_currencystringrequired

Base Currency. Base currency, an enumerated value (currency list, e.g. USD/HKD/CNH).

other_currencystringrequired

Other Currency. Counter currency, an enumerated value (currency list).

record_datestringrequired

Record Date. Record date, format YYYYMMDD; must not be later than the current time.

bid_ratenumberrequired

Bid Rate. Buy rate, which must be greater than 0 (precision per the currency-pair configuration).

offer_ratenumberrequired

Offer Rate. Sell rate, which must be greater than 0 (precision per the currency-pair configuration).

average_ratenumberrequired

Average Rate. The mid rate, which must be greater than 0 (precision per the currency-pair configuration).

audit_frontend_resourceobject

Audit Context. Automatically attached audit fields, containing $behavior (operation description) and $action (fixed value add).

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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