Orders

The orders API contains a private endpoint for querying order state. Requires a base64-encoded SHA256 HMAC signature as defined in Authentication.

Querying Order State

The endpoint supports the following query parameters:

The endpoint returns a pagination response of the type Pagination<Order, CursorInfo>. More details on paginated APIs can be found in Pagination. Order is defined as follows:

export interface Order {
  symbol: string;
  product_id: number;
  product_type: ProductType;
  id: string;
  connection_id: string;
  clearing_firm_code: string;
  account_id: string;
  open_ack_id: string;
  side: Side;
  price: number;
  quantity_requested: number;
  quantity_filled: number;
  status: OrderStatus;
  time_in_force: TimeInForce;
}

export type ProductType = "Future" | "Spread" | "Option";

export type Side = 'Bid' | 'Ask';

export type OrderStatus = 'Working' | 'Closed';

export type TimeInForce = 'IOC' | 'Day' | 'GTC';