Transfer-Out Details · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.transfer_idstring

Request ID

filters.idstring

Transfer-Out Record ID

filters.is_realitystring

Physical Script. Options: 0 = 否; 1 = True

01

filters.statestring

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

0123

filters.created_atobject

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

Child attributes

filters.created_at.gtestring

Greater Than or Equal

filters.created_at.ltestring

Less Than or Equal

filters.apply_statestring

Approval Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 0 = Init; 1 = Pending Success Review; 2 = Pending Fail Review; 3 = Pending Edit Review; 6 = Delete pending approval

01236

filters.member_idstring

Client ID

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

filters.counter_idstring

Stock

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.cheat_statestring

Risk Status. Options: 0 = Risk Control In Progress; 1 = Not Targeted; 2 = Targeted

012

filters.hit_rulesstring

Hit Rules. Values are dynamically queried from aml_transfer_out_rules (not fixed); fetch them live via GET /v1/datasets/refs/risk_rule_indicators_transfer_out.

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_transfer_out_stocks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "transfer_id": "<string>",
        "code": "<string>",
        "real_name": "<string>",
        "origin_id": "<string>",
        "name_locales": "<string>",
        "amount": "<string>",
        "transfer_order_fee": "<string>",
        "custom_transfer_area_fee": "<string>",
        "margin_call_value": "<string>",
        "apply_state": "<string>",
        "auditor": "<string>",
        "updated_at": "<string>",
        "state": "<string>",
        "cheat_state": "<string>",
        "custom_hit_rules": "<string>",
        "si_file_name": "<string>",
        "si_purpose": "<string>",
        "si_account_name": "<string>",
        "si_account": "<string>",
        "broker_id": "<string>",
        "si_broker_code": "<string>",
        "unit_amount": "<string>",
        "close_price": "<string>",
        "market_value": "<string>",
        "statement_remark": "<string>",
        "custodian_before": "<string>",
        "sub_position_no_before": "<string>",
        "street_amount_before": "<string>",
        "nominee_amount_before": "<string>",
        "own_amount_before": "<string>",
        "creator": "<string>",
        "created_at": "<string>",
        "settled_at": "<string>"
      }
    ],
    "total": 0
  }
}