Skip to content
Longport WhaleLongport Whale
Client Notification

Query FX Conversion Details

Returns the currency-exchange details for a given user.

Request parameters

  • Required: aaid (securities account)
  • See the field definitions for each field's format, allowed values, and business meaning.

Returns

On success, returns the user's currency-exchange details. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/query_exchange_v2

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

aaidstringrequired

A/C No.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
cash_booksobject

Cash balance per currency; keys are currencies and values are amount strings with thousands separators.

debt_amountstring

Debt amount.

exchange_amountstring

Exchangeable amount.

cash_books_valobject

Raw-value object for cash_books. May be an empty object.

debt_amount_valstring

Raw value of debt_amount. May be an empty string.

exchange_amount_valstring

Raw value of exchange_amount. May be an empty string.

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