Skip to content
Longport WhaleLongport Whale
Snapshot

Snapshot

Query historical snapshots of stock-borrow (FX) reminders, so the risk team can keep an audit trail and review the owed and convertible state of a reminder at a point in time.

Request parameters

  • Combine business filters through filters (see the filters field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Each record is a snapshot of a borrow / FX reminder at a given moment, carrying the snapshot ID, snapshot time, reminder ID, securities account number, origin, trigger time, currency, owed amount, and convertible other-currency amount.
  • Snapshots are used for audit and traceability, preserving the data as it stood when a reminder was created or changed.
  • Filter by reminder ID, snapshot time, customer, or origin (multi-select supported).

Returns

On success, returns the matched records and pagination info. See the response schema for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes
exchange_log_idstring

Log ID. Filters results by Log ID.

created_atstring

Created At. Filters results by Created At.

aaidstring

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

backup_originstring

Backup Origin. Filters results by Backup Origin.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 0 Auto Conversion, 1 Auto Notification, 2 Auto Redemption, 3 MMF-trigger Conversion, 4 Completed, 5 Manual Conversion

Values
0
Auto Conversion
1
Auto Notification
2
Auto Redemption
3
MMF-trigger Conversion
4
Completed
5
Manual Conversion
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 Stock Borrow Reminder Snapshot 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.

created_atstring

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

exchange_log_idstring

Log ID. Returned value: Log ID.

origin_idstring

Account No.. Returned value: Account No..

backup_originstring

Origin. Returned value: Origin.

backup_origin_valstring

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

alert_timestring

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

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.

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