Skip to content
Longport WhaleLongport Whale
Exchange P／L

Exchange P/L

Queries Exchange P/L 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_profit_loss

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

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
forex_idstring

Conversion Order No.. Filters results by Conversion Order No..

client_ordidstring

Channel Conversion Order No.. Filters results by Channel Conversion Order No..

forex_typestring

Exchange Type. Filters results by Exchange Type.

Allowed values: FROM, TO

FROMTO

currencystring

Currency. Filters results by 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.

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.

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 Exchange P/L 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: Records matching the query conditions.

Child attributes
forex_idstring

Conversion Order No.. Returned value: Conversion Order No..

client_ordidstring

Channel Conversion Order No.. Returned value: Channel Conversion Order No..

channel_namestring

Exchange Channel. Returned value: Exchange Channel.

forex_typestring

Exchange Type. Returned value: Exchange Type.

currencystring

Currency. Returned value: Currency.

channel_ratestring

Channel Exchange Rate. Returned value: Channel Exchange Rate.

channel_amountstring

Channel Amount. Returned value: Channel Amount.

user_ratestring

Client Exchange Rate. Returned value: Client Exchange Rate.

user_amountstring

Client Amount. Returned value: Client Amount.

channel_ledger_datestring

Channel accounting date. Returned value: Channel accounting date. The date or time format follows the value returned by the API.

sett_ledger_datestring

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

profit_lossstring

Exchange P/L. Returned value: Exchange P/L.

order_offsetstring

Rounding. Returned value: Rounding.

updated_atstring

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

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