Skip to content
Longport WhaleLongport Whale
Client Notification

Exchange Record

Query the currency-exchange transactions actually executed to repay debit balances, so the risk team can reconcile the outcome of each conversion.

Request parameters

  • Combine business filters through filters (see the filters field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Each record represents one exchange operation and carries an ID, the buy-in currency and amount, the sell-out currency and amount, the exchange result, the processed time, and the operator.
  • Records are linked to their originating FX reminder / stock-borrow entry, reflecting how a debit balance was actually repaid.
  • Locate a specific record by its historical ID or the linked borrow ID.

Returns

On success, returns the matched records and pagination info. See the response schema for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_exchange_records

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.risk_debt_info

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

Request body application/json

filtersobject

Filters

Child attributes
idstring

Historical ID

exchange_log_idstring

Multicurrency Deficit ID

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

exchange_idstring

ID

to_currencystring

To Currency

to_amountstring

To Amount

from_currencystring

From Currency

from_amountstring

From Amount

statestring

Exchange Result

state_valstring

Exchange Result (raw value). Raw value behind field state: state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

updated_atstring

Processed At

op_userstring

Processed By

totalintegerrequired

Total

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