Transfer-In Details Export

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes

filters.member_idstring

Member ID

filters.idstring

Transfer-In Record ID

filters.rollover_idstring

Transfer-In Request ID

filters.origin_idstring

A/C No

filters.apply_statestring

Approval Status. Options: 0 = Init; 1 = Pending Success Review; 2 = Pending Fail Review; 3 = Pending Edit Review; 4 = Pending Release Review; 5 = Pending Release; 6 = Delete pending approval

0123456

filters.statestring

Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 0 = Pending; 1 = Success; 2 = Fail; 3 = Deleted

0123

filters.counter_idstring

Stock

filters.created_atobject

Created At. Range filter; both bounds are optional (omit a bound to leave that side unbounded). Defaults to the range [6 day(s) ago, today] when omitted (gte/lte roll with the request date).

Child attributes

filters.created_at.gtestring

Greater Than or Equal

filters.created_at.ltestring

Less Than or Equal

filters.settled_atobject

Settled At. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.settled_at.gtestring

Greater Than or Equal

filters.settled_at.ltestring

Less Than or Equal

filters.si_file_namestring

SI Report Name

filters.is_realitystring

Physical Scrip?. Options: 0 = 否; 1 = True

01

filters.marketstring

Market. Options: US = US; HK = HK; UK = UK; SH = SH; SZ = SZ; SG = SG; KR = KR; JP = JP; AU = AU; DE = DE; CA = CA; TH = TH; ID = ID; MY = MY; TR = TR; NA = NA; OSL = OSL; HAS = HAS; EU = EU; UT = UT; GTMMF = GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_rollover_stocks/download' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "orderBy": [],
  "mode": 0,
  "ext": "csv",
  "file_name": "",
  "remark": "",
  "down_fields": [],
  "ticket_content": "",
  "ticket_preview_url": "",
  "hide": 0
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "url": "<string>",
    "file_download_id": "<string>",
    "ticket_id": "<string>"
  }
}