Exchange Order · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.forex_idstring

Conversion Order No

filters.client_ordidstring

Channel Exchange Order ID

filters.member_idstring

Client ID

filters.forex_typestring

Exchange Type. Options: FROM = FROM; TO = TO

FROMTO

filters.from_currencystring

Debit Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.to_currencystring

Credit Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.created_atobject

Created Time. 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.success_timeobject

Exchange Completion Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.success_time.gtestring

Greater Than or Equal

filters.success_time.ltestring

Less Than or Equal

filters.audit_statusstring

Review Status. Options: WAIT_AUDIT = Pending Review; REJECTED_AUDIT = Rejected; APPROVED_AUDIT = Reviewed

WAIT_AUDITREJECTED_AUDITAPPROVED_AUDIT

filters.originstring

Requestor. Options: 0 = User; 1 = Manual; 2 = WAS; 3 = Auto; 4 = Force

01234

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_forex_orders' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "forex_id": "<string>",
        "client_ordid": "<string>",
        "member_id": "<string>",
        "origin_id": "<string>",
        "forex_type": "<string>",
        "change_type": "<string>",
        "service_strategy": "<string>",
        "from_currency": "<string>",
        "from_amount": "<string>",
        "to_currency": "<string>",
        "to_amount": "<string>",
        "rate": "<string>",
        "fx_currency": "<string>",
        "fx_amount": "<string>",
        "fx_rate": "<string>",
        "reference_rate": "<string>",
        "bid_rate": "<string>",
        "created_at": "<string>",
        "finish_time": "<string>",
        "success_time": "<string>",
        "forex_status": "<string>",
        "origin": "<string>",
        "audit_status": "<string>",
        "audit_remark": "<string>",
        "order_remark": "<string>"
      }
    ],
    "total": 0
  }
}