Skip to content
Longport WhaleLongport Whale
Client Notification

FX Reminder Query

Queries FX Reminder Query 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_alerts

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_info

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

Client. Filters results by Client.

alert_timestring

Triggered At. Filters results by Triggered At.

updated_atstring

Updated At. Filters results by Updated At.

is_autostring

Auto Convert. Filters results by Auto Convert.

true · Openfalse · Closed

statusstring

Status. Filters results by Status.

0 · Pending5 · Closed/ Completed2 · FX - PENDING1 · FX - PENDING APPROVAL3 · FX - FAIL

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

aaidstring

Client. Returned value: Client.

aaid_valstring

Client (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. Returned value: Debit Balance Amt.

own_amountstring

Other Currency Available Amt. Returned value: Other Currency Available Amt.

is_autostring

Auto Convert. Returned value: Indicates whether auto convert.

is_auto_valstring

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

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.

updated_atstring

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