Skip to content
Longport Whale
CRS Data

CRS Data Query Export

Export the CRS Data Query list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/report_crs_records/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of report_crs_records.yaml (the query capability).

Child attributes
filters.return_yearstring

Return Year. Values are dynamically queried from report_crs_return_year (not fixed); fetch them live via GET /v1/datasets/refs/crs_return_year.

filters.message_typestring

Message Type. Options: CRS701 = New [CRS701]; CRS702 = Corrections[CRS702]

CRS701CRS702

filters.aeoi_idstring

Aeoi Id. Values are dynamically queried from report_crs_aeoi_id (not fixed); fetch them live via GET /v1/datasets/refs/crs_aeoi_id.

filters.account_nostring

Account Number

filters.batchstring

Batch. Values are dynamically queried from report_crs_batch (not fixed); fetch them live via GET /v1/datasets/refs/crs_batch.

filters.client_typestring

Client Type. Options: P = Person; O = Organization

PO

filters.doc_typestring

Doc Type. Options: OECD1 = New Data [OECD1]; OECD2 = Corrected Data [OECD2]; OECD3 = Deletion of Data [OECD3]

OECD1OECD2OECD3

filters.messagestring

Message Number. Values are dynamically queried from report_crs_message (not fixed); fetch them live via GET /v1/datasets/refs/crs_message_id.

filters.account_statestring

Account Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: -1 = Closed; 0 = Unactive; 1 = Active; 99 = Suspend; 4 = Suspended; 5 = Dormant

-1019945

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Whale Docs