Skip to content
Structured Product Trading

List Structured Product Orders

Returns the current account's structured product orders, paginated and filtered by date, product type, currency, and status. offset is the page number starting from 1. Fewer items than page_size means there is no more data. Get filter values from GET /v1/wms/orders/filter_info. When the Client taps an order, call GET /v1/wms/orders/info with its order_id.

GEThttps://api.lbkrs.com/v1/wms/orders/list

Parameters

offsetintegerqueryRequired

Page number, starting from 1

page_sizeintegerqueryRequired

Items per page

start_datestringquery

Start of the order date range, in YYYY-MM-DD

end_datestringquery

End of the order date range, in YYYY-MM-DD

product_typestringquery

Product type from the order filters

currencystringquery

Currency from the order filters

statusstringquery

Order status

12345678

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Structured Product Orders” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
order_infoarray<object>

Orders

Child attributes
order_idinteger

Order ID used to query order details

counter_idstring

Structured product code

idea_idstring

Product idea ID

quote_idstring

Quote ID

instrument_namestring

Product name

product_typestring

Product type

product_type_localesstring

Localized product type text

currencystring

Order currency

currency_localesstring

Localized currency text shown after the order amount

directionstring

Display text of the order direction

quantitystring

Order amount (notional)

executed_quantitystring

Executed amount

statusstring

Order status:

  • 1 - Initial
  • 2 - Submitted (can be canceled)
  • 3 - Processing
  • 4 - Executed
  • 5 - Completed
  • 6 - Rejected
  • 7 - Canceled
  • 8 - Expired
Values
1
2
3
4
5
6
7
8
create_atinteger

Order creation time as a Unix timestamp in seconds

Whale Docs