Skip to content
Longport WhaleLongport Whale
Exchange Order

User Foreign Exchange Statistics

Query aggregate statistics over client FX conversion orders, giving an overview of the current processing volume and recent scale of the exchange business.

Request parameters

  • This dataset provides no business filter fields; pass an empty object for filters. You can still use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • The data is aggregated from client FX conversion orders and returns several summary counts rather than a detail list.
  • The counts cover pending orders, in-progress orders, completed orders (including failed, approved, rejected, and cancelled), and orders created in the last 7 days.
  • Typically used on the operations side to monitor the overall processing progress and workload distribution of the exchange business.

Returns

On success, returns the list of matching records with pagination information. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_conversion.userexchangebill_query

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

Request body application/json

filtersobject

Filters

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
submit_numstring

Pending processing

processing_numstring

Processing

complete_numstring

Completed

all_numstring

Last 7 days

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