Skip to content

Latest commit

 

History

History
390 lines (296 loc) · 32.8 KB

OrderApi.md

File metadata and controls

390 lines (296 loc) · 32.8 KB
Raw

OrderApi

All URIs are relative to https://www.bitmex.com/api/v1

Method HTTP request Description
orderAmend PUT /order Amend the quantity or price of an open order.
orderCancel DELETE /order Cancel order(s). Send multiple order IDs to cancel in bulk.
orderCancelAll DELETE /order/all Cancels all of your orders.
orderCancelAllAfter POST /order/cancelAllAfter Automatically cancel all your orders after a specified timeout.
orderClosePosition POST /order/closePosition Close a position. [Deprecated, use POST /order with execInst: 'Close']
orderGetOrders GET /order Get your orders.
orderNew POST /order Create a new order.

orderAmend

Order orderAmend(orderID, origClOrdID, clOrdID, simpleOrderQty, orderQty, simpleLeavesQty, leavesQty, price, stopPx, pegOffsetValue, text)

Amend the quantity or price of an open order.

Send an `orderID` or `origClOrdID` to identify the order you wish to amend. Both order quantity and price can be amended. Only one `qty` field can be used to amend. Use the `leavesQty` field to specify how much of the order you wish to remain open. This can be useful if you want to adjust your position's delta by a certain amount, regardless of how much of the order has already filled. > A `leavesQty` can be used to make a "Filled" order live again, if it is received within 60 seconds of the fill.

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
String orderID = "orderID_example"; // String | Order ID
String origClOrdID = "origClOrdID_example"; // String | Client Order ID. See POST /order.
String clOrdID = "clOrdID_example"; // String | Optional new Client Order ID, requires `origClOrdID`.
Double simpleOrderQty = 3.4D; // Double | Deprecated: simple orders are not supported after 2018/10/26
Integer orderQty = 56; // Integer | Optional order quantity in units of the instrument (i.e. contracts, for spot it is the base currency in minor currency (e.g. XBt quantity for XBT)).
Double simpleLeavesQty = 3.4D; // Double | Deprecated: simple orders are not supported after 2018/10/26
Integer leavesQty = 56; // Integer | Optional leaves quantity in units of the instrument (i.e. contracts, for spot it is the base currency in minor currency (e.g. XBt quantity for XBT)). Useful for amending partially filled orders.
Double price = 3.4D; // Double | Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders.
Double stopPx = 3.4D; // Double | Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders.
Double pegOffsetValue = 3.4D; // Double | Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders.
String text = "text_example"; // String | Optional amend annotation. e.g. 'Adjust skew'.
try {
    Order result = apiInstance.orderAmend(orderID, origClOrdID, clOrdID, simpleOrderQty, orderQty, simpleLeavesQty, leavesQty, price, stopPx, pegOffsetValue, text);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderAmend");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderID String Order ID [optional]
origClOrdID String Client Order ID. See POST /order. [optional]
clOrdID String Optional new Client Order ID, requires `origClOrdID`. [optional]
simpleOrderQty Double Deprecated: simple orders are not supported after 2018/10/26 [optional]
orderQty Integer Optional order quantity in units of the instrument (i.e. contracts, for spot it is the base currency in minor currency (e.g. XBt quantity for XBT)). [optional]
simpleLeavesQty Double Deprecated: simple orders are not supported after 2018/10/26 [optional]
leavesQty Integer Optional leaves quantity in units of the instrument (i.e. contracts, for spot it is the base currency in minor currency (e.g. XBt quantity for XBT)). Useful for amending partially filled orders. [optional]
price Double Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders. [optional]
stopPx Double Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. [optional]
pegOffsetValue Double Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders. [optional]
text String Optional amend annotation. e.g. 'Adjust skew'. [optional]

Return type

Order

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderCancel

List<Order> orderCancel(orderID, clOrdID, text)

Cancel order(s). Send multiple order IDs to cancel in bulk.

Either an orderID or a clOrdID must be provided.

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
String orderID = "orderID_example"; // String | Order ID(s).
String clOrdID = "clOrdID_example"; // String | Client Order ID(s). See POST /order.
String text = "text_example"; // String | Optional cancellation annotation. e.g. 'Spread Exceeded'.
try {
    List<Order> result = apiInstance.orderCancel(orderID, clOrdID, text);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderCancel");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderID String Order ID(s). [optional]
clOrdID String Client Order ID(s). See POST /order. [optional]
text String Optional cancellation annotation. e.g. 'Spread Exceeded'. [optional]

Return type

List<Order>

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderCancelAll

List<Order> orderCancelAll(targetAccountIds, symbol, filter, text)

Cancels all of your orders.

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
String targetAccountIds = "targetAccountIds_example"; // String | AccountIds to cancel all orders, must be a paired account with main user. Also accepts wildcard, [*], this will cancel all orders for all accounts. the authenticated user has order write permissions for.
String symbol = "symbol_example"; // String | Optional symbol. If provided, only cancels orders for that symbol.
String filter = "filter_example"; // String | Optional filter for cancellation. Use to only cancel some orders, e.g. `{\"side\": \"Buy\"}`.
String text = "text_example"; // String | Optional cancellation annotation. e.g. 'Spread Exceeded'
try {
    List<Order> result = apiInstance.orderCancelAll(targetAccountIds, symbol, filter, text);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderCancelAll");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
targetAccountIds String AccountIds to cancel all orders, must be a paired account with main user. Also accepts wildcard, [*], this will cancel all orders for all accounts. the authenticated user has order write permissions for. [optional]
symbol String Optional symbol. If provided, only cancels orders for that symbol. [optional]
filter String Optional filter for cancellation. Use to only cancel some orders, e.g. `{&quot;side&quot;: &quot;Buy&quot;}`. [optional]
text String Optional cancellation annotation. e.g. 'Spread Exceeded' [optional]

Return type

List<Order>

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderCancelAllAfter

Object orderCancelAllAfter(timeout)

Automatically cancel all your orders after a specified timeout.

Useful as a dead-man's switch to ensure your orders are canceled in case of an outage. If called repeatedly, the existing offset will be canceled and a new one will be inserted in its place. Example usage: call this route at 15s intervals with an offset of 60000 (60s). If this route is not called within 60 seconds, all your orders will be automatically canceled. This is also available via WebSocket.

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
Double timeout = 3.4D; // Double | Timeout in ms. Set to 0 to cancel this timer. 
try {
    Object result = apiInstance.orderCancelAllAfter(timeout);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderCancelAllAfter");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
timeout Double Timeout in ms. Set to 0 to cancel this timer.

Return type

Object

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderClosePosition

Order orderClosePosition(symbol, price)

Close a position. [Deprecated, use POST /order with execInst: 'Close']

If no `price` is specified, a market order will be submitted to close the whole of your position. This will also close all other open orders in this symbol.

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
String symbol = "symbol_example"; // String | Symbol of position to close.
Double price = 3.4D; // Double | Optional limit price.
try {
    Order result = apiInstance.orderClosePosition(symbol, price);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderClosePosition");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
symbol String Symbol of position to close.
price Double Optional limit price. [optional]

Return type

Order

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderGetOrders

List<Order> orderGetOrders(symbol, filter, columns, count, start, reverse, startTime, endTime)

Get your orders.

To get open orders only, send {&quot;open&quot;: true} in the filter param. See <a href=&quot;http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_D_68.html\&quot;&gt;the FIX Spec</a> for explanations of these fields.

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
String symbol = "symbol_example"; // String | Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.  You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.  Symbols are case-insensitive.
String filter = "filter_example"; // String | Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details.
String columns = "columns_example"; // String | Array of column names to fetch. If omitted, will return all columns.  Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Integer count = 100; // Integer | Number of results to fetch. Must be a positive integer.
Integer start = 0; // Integer | Starting point for results.
Boolean reverse = false; // Boolean | If true, will sort results newest first.
Date startTime = new Date(); // Date | Starting date filter for results.
Date endTime = new Date(); // Date | Ending date filter for results.
try {
    List<Order> result = apiInstance.orderGetOrders(symbol, filter, columns, count, start, reverse, startTime, endTime);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderGetOrders");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
symbol String Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`. Symbols are case-insensitive. [optional]
filter String Generic table filter. Send JSON key/value pairs, such as `{&quot;key&quot;: &quot;value&quot;}`. You can key on individual fields, and do more advanced querying on timestamps. See the Timestamp Docs for more details. [optional]
columns String Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect. [optional]
count Integer Number of results to fetch. Must be a positive integer. [optional] [default to 100]
start Integer Starting point for results. [optional] [default to 0]
reverse Boolean If true, will sort results newest first. [optional] [default to false]
startTime Date Starting date filter for results. [optional]
endTime Date Ending date filter for results. [optional]

Return type

List<Order>

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderNew

Order orderNew(symbol, side, simpleOrderQty, orderQty, price, displayQty, stopPx, clOrdID, clOrdLinkID, pegOffsetValue, pegPriceType, ordType, timeInForce, execInst, contingencyType, text)

Create a new order.

Placing Orders This endpoint is used for placing orders. See individual fields below for more details on their use. #### Order Types All orders require a `symbol`. All other fields are optional except when otherwise specified. These are the valid `ordType`s: - Limit: The default order type. Specify an `orderQty` and `price`. - Market: A traditional Market order. A Market order will execute until filled or your bankruptcy price is reached, at which point it will cancel. - Stop: A Stop Market order. Specify an `orderQty` and `stopPx`. When the `stopPx` is reached, the order will be entered into the book. - On sell orders, the order will trigger if the triggering price is lower than the `stopPx`. On buys, higher. - Note: Stop orders do not consume margin until triggered. Be sure that the required margin is available in your account so that it may trigger fully. - `Close` Stops don't require an `orderQty`. See Execution Instructions below. - StopLimit: Like a Stop Market, but enters a Limit order instead of a Market order. Specify an `orderQty`, `stopPx`, and `price`. - MarketIfTouched: Similar to a Stop, but triggers are done in the opposite direction. Useful for Take Profit orders. - LimitIfTouched: As above; use for Take Profit Limit orders. - Pegged: Pegged orders allow users to submit a limit price relative to the current market price. Specify a `pegPriceType`, and `pegOffsetValue`. - Pegged orders must have an `execInst` of `Fixed`. This means the limit price is set at the time the order is accepted and does not change as the reference price changes. - `PrimaryPeg`: Price is set relative to near touch price. - `MarketPeg`: Price is set relative to far touch price. - A `pegPriceType` submitted with no `ordType` is treated as a `Pegged` order. #### Execution Instructions The following `execInst`s are supported. If using multiple, separate with a comma (e.g. `LastPrice,Close`). - ParticipateDoNotInitiate: Also known as a Post-Only order. If this order would have executed on placement, it will cancel instead. This is intended to protect you from the far touch moving towards you while the order is in transit. It is not intended for speculating on the far touch moving away after submission - we consider such behaviour abusive and monitor for it. - MarkPrice, LastPrice, IndexPrice: Used by stop and if-touched orders to determine the triggering price. Use only one. By default, `MarkPrice` is used. Also used for Pegged orders to define the value of `LastPeg`. IndexPrice is not applicable to spot trading symbols. - ReduceOnly: A `ReduceOnly` order can only reduce your position, not increase it. If you have a `ReduceOnly` limit order that rests in the order book while the position is reduced by other orders, then its order quantity will be amended down or canceled. If there are multiple `ReduceOnly` orders the least aggressive will be amended first. Not applicable to spot trading symbols. - Close: `Close` implies `ReduceOnly`. A `Close` order will cancel other active limit orders with the same side and symbol if the open quantity exceeds the current position. This is useful for stops: by canceling these orders, a `Close` Stop is ensured to have the margin required to execute, and can only execute up to the full size of your position. If `orderQty` is not specified, a `Close` order has an `orderQty` equal to your current position's size. Not applicable to spot trading symbols. - Note that a `Close` order without an `orderQty` requires a `side`, so that BitMEX knows if it should trigger above or below the `stopPx`. - LastWithinMark: Used by stop orders with `LastPrice` to allow stop triggers only when: - For Sell Stop Market / Stop Limit Order - Last Price &lt= Stop Price - Last Price &gt= Mark Price × (1 - 5%) - For Buy Stop Market / Stop Limit Order: - Last Price &gt= Stop Price - Last Price &lt= Mark Price × (1 + 5%) - Not applicable to spot trading symbols. - Fixed: Pegged orders must have an `execInst` of `Fixed`. This means the limit price is set at the time the order is accepted and does not change as the reference price changes. #### Pegged Orders Pegged orders allow users to submit a limit price relative to the current market price. The limit price is set once when the order is submitted and does not change with the reference price. This order type is not intended for speculating on the far touch moving away after submission - we consider such behaviour abusive and monitor for it. Pegged orders have an `ordType` of `Pegged`, and an `execInst` of `Fixed`. A `pegPriceType` and `pegOffsetValue` must also be submitted: - `PrimaryPeg` - price is set relative to the near touch price - `MarketPeg` - price is set relative to the far touch price #### Trailing Stop Pegged Orders Use `pegPriceType` of `TrailingStopPeg` to create Trailing Stops. The price is set at submission and updates once per second if the underlying price (last/mark/index) has moved by more than 0.1%. `stopPx` then moves as the market moves away from the peg, and freezes as the market moves toward it. Use `pegOffsetValue` to set the `stopPx` of your order. The peg is set to the triggering price specified in the `execInst` (default `MarkPrice`). Use a negative offset for stop-sell and buy-if-touched orders. Requires `ordType`: `Stop`, `StopLimit`, `MarketIfTouched`, `LimitIfTouched`. #### Linked Orders Linked Orders are an advanced capability. It is very powerful, but its use requires careful coding and testing. Please follow this document carefully and use the Testnet Exchange while developing. BitMEX offers four advanced Linked Order types: - OCO: One Cancels the Other. A very flexible version of the standard Stop / Take Profit technique. Multiple orders may be linked together using a single `clOrdLinkID`. Send a `contingencyType` of `OneCancelsTheOther` on the orders. The first order that fully or partially executes (or activates for `Stop` orders) will cancel all other orders with the same `clOrdLinkID`. - OTO: One Triggers the Other. Send a `contingencyType` of `'OneTriggersTheOther'` on the primary order and then subsequent orders with the same `clOrdLinkID` will be not be triggered until the primary order fully executes. #### Trailing Stops You may use `pegPriceType` of `'TrailingStopPeg'` to create Trailing Stops. The pegged `stopPx` will move as the market moves away from the peg, and freeze as the market moves toward it. To use, combine with `pegOffsetValue` to set the `stopPx` of your order. The peg is set to the triggering price specified in the `execInst` (default `'MarkPrice'`). Use a negative offset for stop-sell and buy-if-touched orders. Requires `ordType`: `'Stop', 'StopLimit', 'MarketIfTouched', 'LimitIfTouched'`. #### Simple Quantities Simple Quantities are deprecated as of 2018/10/26 #### Rate Limits You can improve your reactivity to market movements while staying under your rate limit by using the Amend endpoint (PUT /order). This allows you to stay in the market and avoids the cancel/replace cycle. #### Tracking Your Orders If you want to keep track of order IDs yourself, set a unique `clOrdID` per order. This `clOrdID` will come back as a property on the order and any related executions (including on the WebSocket), and can be used to get or cancel the order. Max length is 36 characters. You can also change the `clOrdID` by amending an order, supplying an `origClOrdID`, and your desired new ID as the `clOrdID` param, like so: ``` # Amends an order's leavesQty, and updates its clOrdID to &quot;def-456&quot; PUT /api/v1/order {&quot;origClOrdID&quot;: &quot;abc-123&quot;, &quot;clOrdID&quot;: &quot;def-456&quot;, &quot;leavesQty&quot;: 1000} ```

Example

// Import classes:
//import io.swagger.client.api.OrderApi;

OrderApi apiInstance = new OrderApi();
String symbol = "symbol_example"; // String | Instrument symbol. e.g. 'XBTUSD'.
String side = "side_example"; // String | Order side. Valid options: Buy, Sell. Defaults to 'Buy' unless `orderQty` is negative.
Double simpleOrderQty = 3.4D; // Double | Deprecated: simple orders are not supported after 2018/10/26
Integer orderQty = 56; // Integer | Order quantity in units of the instrument (i.e. contracts, for spot it is base currency in minor currency for spot (e.g. XBt quantity for XBT)).
Double price = 3.4D; // Double | Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders.
Integer displayQty = 56; // Integer | Optional quantity to display in the book. Use 0 for a fully hidden order.
Double stopPx = 3.4D; // Double | Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use `execInst` of 'MarkPrice' or 'LastPrice' to define the current price used for triggering.
String clOrdID = "clOrdID_example"; // String | Optional Client Order ID. This clOrdID will come back on the order and any related executions.
String clOrdLinkID = "clOrdLinkID_example"; // String | Optional Client Order Link ID for contingent orders
Double pegOffsetValue = 3.4D; // Double | Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders.
String pegPriceType = "pegPriceType_example"; // String | Optional peg price type. Valid options: MarketPeg, PrimaryPeg, TrailingStopPeg.
String ordType = "Limit"; // String | Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, Pegged. Defaults to 'Limit' when `price` is specified. Defaults to 'Stop' when `stopPx` is specified. Defaults to 'StopLimit' when `price` and `stopPx` are specified.
String timeInForce = "timeInForce_example"; // String | Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to 'GoodTillCancel' for 'Limit', 'StopLimit', and 'LimitIfTouched' orders.
String execInst = "execInst_example"; // String | Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed, LastWithinMark. 'AllOrNone' instruction requires `displayQty` to be 0. 'MarkPrice', 'IndexPrice' or 'LastPrice' instruction valid for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. 'LastWithinMark' instruction valid for 'Stop' and 'StopLimit' with instruction 'LastPrice'. IndexPrice, LastWithMark, Close and ReduceOnly are not applicable to spot trading symbols.
String contingencyType = "contingencyType_example"; // String | Optional contingency type for use with `clOrdLinkID`. Valid options: OneCancelsTheOther, OneTriggersTheOther.
String text = "text_example"; // String | Optional order annotation. e.g. 'Take profit'.
try {
    Order result = apiInstance.orderNew(symbol, side, simpleOrderQty, orderQty, price, displayQty, stopPx, clOrdID, clOrdLinkID, pegOffsetValue, pegPriceType, ordType, timeInForce, execInst, contingencyType, text);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderApi#orderNew");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
symbol String Instrument symbol. e.g. 'XBTUSD'.
side String Order side. Valid options: Buy, Sell. Defaults to 'Buy' unless `orderQty` is negative. [optional]
simpleOrderQty Double Deprecated: simple orders are not supported after 2018/10/26 [optional]
orderQty Integer Order quantity in units of the instrument (i.e. contracts, for spot it is base currency in minor currency for spot (e.g. XBt quantity for XBT)). [optional]
price Double Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders. [optional]
displayQty Integer Optional quantity to display in the book. Use 0 for a fully hidden order. [optional]
stopPx Double Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use `execInst` of 'MarkPrice' or 'LastPrice' to define the current price used for triggering. [optional]
clOrdID String Optional Client Order ID. This clOrdID will come back on the order and any related executions. [optional]
clOrdLinkID String Optional Client Order Link ID for contingent orders [optional]
pegOffsetValue Double Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders. [optional]
pegPriceType String Optional peg price type. Valid options: MarketPeg, PrimaryPeg, TrailingStopPeg. [optional]
ordType String Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, Pegged. Defaults to 'Limit' when `price` is specified. Defaults to 'Stop' when `stopPx` is specified. Defaults to 'StopLimit' when `price` and `stopPx` are specified. [optional] [default to Limit]
timeInForce String Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to 'GoodTillCancel' for 'Limit', 'StopLimit', and 'LimitIfTouched' orders. [optional]
execInst String Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed, LastWithinMark. 'AllOrNone' instruction requires `displayQty` to be 0. 'MarkPrice', 'IndexPrice' or 'LastPrice' instruction valid for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. 'LastWithinMark' instruction valid for 'Stop' and 'StopLimit' with instruction 'LastPrice'. IndexPrice, LastWithMark, Close and ReduceOnly are not applicable to spot trading symbols. [optional]
contingencyType String Optional contingency type for use with `clOrdLinkID`. Valid options: OneCancelsTheOther, OneTriggersTheOther. [optional]
text String Optional order annotation. e.g. 'Take profit'. [optional]

Return type

Order

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript