Orders

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

Submitting Orders

Orders on the Bitnomial Exchange are bids to buy a product, or asks to sell that product. Beyond the order price and quantity requested, an order is treated differently based on its time-in-force, of which there are three:

• immediate-or-cancel (IOC) orders will be cancelled if they cannot be matched immediately;
• day orders are valid until they either match, get cancelled explicitly by the user, or the end of the daily trading session is reached.
• good-till-cancel (GTC) orders are valid until they match, get cancelled explicitly by the user, or the product they refer to is no longer listed.

Note: Order submissions are currently only available in the production environment.

Request Parameters

The supported query parameters are:

The body of the POST request is a JSON object, expected to have the following fields:

The schema of the body of the request is formally defined as:

export type OrderSubmission = {
  price: number;
  product_symbol: string;
  quantity_requested: number;
  side: Side;
  time_in_force: TimeInForce;
};

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

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

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';