Skip to content
Longport WhaleLongport Whale
CRS Import

Historical Annual Returns Data

Queries Historical Annual Returns Data data. Combine business filters in filters, and use page and page_size to control pagination.

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.

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_crs_histories

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

Authorization

AuthorizationstringheaderRequired

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

Permission

report.crs_data

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

Request body application/json

filtersobject

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

Child attributes
member_idstring

Filters results by Client.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Historical Annual Returns Data records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: Records matching the query conditions.

Child attributes
return_yearstring

Returned value: Year.

member_idstring

Returned value: Client ID.

account_nostring

Returned value: Account No.

crs501string

Returned value: Dividend.

crs502string

Returned value: Net Interest.

crs503string

Returned value: Total Revenue.

crs504string

Returned value: Other Income.

totalintegerrequired

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

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_crs_histories/download
report.crs_data
Export optionsExport recordsDownload result
Whale Docs