Generate CRS File · Whale Docs

POSThttps://b-api.longbridge.xyz/crs/generate_crs_file

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

return_yearstringrequired

Return Year. Dropdown offers a selection of the past 10 years (the current year and the preceding 9 years).

batchstringrequired

Batch. The batch; the values come from the report_crs_batch dynamic enum and are not fixed.

task_typenumber

File Type. Single-select; enum: 1 = Data (filtered out and not selectable in the form), 2 = Test, 3 = Formal; defaults to 3.

aeoi_idstringrequired

AEOI ID. Read-only; passed in via the page URL parameter, not editable.

message_typestringrequired

Message Type. Read-only; passed in via the page URL parameter, not editable.

messagestringrequired

Message ID. Read-only; passed in via the page URL parameter, not editable.

total_countnumberrequired

Data Count. Read-only, computed by the page (the total number of records in the current list).

Responses

HTTP 200No confirmable field definitions are available for the response yet.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/crs/generate_crs_file' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "return_year": "2025",
  "batch": "B202501",
  "task_type": 3,
  "aeoi_id": "AEOI00123",
  "message_type": "CRS703",
  "message": "MSG20250101000001",
  "total_count": 128
}'

Response

{
  "code": 0,
  "message": null,
  "data": {}
}