Skip to content
Longport WhaleLongport Whale
Notification History

Notification History

Queries FX Reminder History Record 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/risk_debt_alert_histories

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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

AuthorizationstringheaderRequired

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

Permission

margin_call.risk_debt_history_info_query

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
aaidstring

Please Select A/C. Filters results by Please Select A/C.

alert_timestring

Triggered At. Filters results by Triggered At.

end_timestring

Completed At. Filters results by Completed At.

statusstring

Stauts. Filters results by Stauts.

5 · Auto Completed (System)6 · Manual FX (User)7 · Auto FX

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 FX Reminder History Record 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: List of list.

Child attributes
idstring

ID. Returned value: Unique identifier of the current record.

account_channelstring

Account Channel. Returned value: Account Channel.

aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

debt_currencystring

Currency. Returned value: Currency.

debt_amountstring

Debit Balance Amt (Before). Returned value: Debit Balance Amt (Before).

new_debt_amountstring

Debit Balance Amt (After). Returned value: Debit Balance Amt (After).

own_amountstring

Other Currency Available Amt (Before). Returned value: Other Currency Available Amt (Before).

new_own_amountstring

Other Currency Available Amt (After). Returned value: Other Currency Available Amt (After).

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

alert_timestring

Triggered At. Returned value: Triggered At. The date or time format follows the value returned by the API.

alert_end_timestring

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

end_timestring

Completed At. Returned value: Completed At. 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