v1

latestOpenAPI 3.0.12026-07-2683220192.3 KB
Report

Search orders

Searches for exchange orders using the given details to filter

post/v1/report/orders/search

Request body

pageSizeinteger
pageTokenstring
orderIdstring
clordIdstring
startTimestring date-time
endTimestring date-time
symbolstring
accountsstring[]
side'SIDE_BUY' | 'SIDE_SELL'

Side indicates the side of an Order.

type'ORDER_TYPE_MARKET_TO_LIMIT' | 'ORDER_TYPE_LIMIT' | 'ORDER_TYPE_STOP' | 'ORDER_TYPE_STOP_LIMIT'

OrderType indicates the type of an order.

orderStateFilter'ORDER_STATE_FILTER_OPEN' | 'ORDER_STATE_FILTER_CLOSED' | 'ORDER_STATE_FILTER_NEW' | 'ORDER_STATE_FILTER_PARTIALLY_FILLED' | 'ORDER_STATE_FILTER_FILLED' | 'ORDER_STATE_FILTER_CANCELED' | 'ORDER_STATE_FILTER_REPLACED' | 'ORDER_STATE_FILTER_REJECTED' | 'ORDER_STATE_FILTER_EXPIRED' | 'ORDER_STATE_FILTER_PENDING_RISK'

OrderStateFilter describes a filter for searching orders that are open or closed.

crossIdstring
hostCrossIdstring
clientAccountIdstring
clientParticipantIdstring
parentOrderIdstring
withLastExecutionboolean

Response

A successful response.

nextPageTokenstring