All URIs are relative to https://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| OrderAmend | Put /order | Amend the quantity or price of an open order. |
| OrderAmendBulk | Put /order/bulk | Amend multiple orders for the same symbol. |
| 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. |
| OrderNewBulk | Post /order/bulk | Create multiple new orders for the same symbol. |
Order OrderAmend(ctx, optional) 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. Use the simpleOrderQty and simpleLeavesQty fields to specify order size in Bitcoin, rather than contracts. These fields will round up to the nearest contract. Like order placement, amending can be done in bulk. Simply send a request to PUT /api/v1/order/bulk with a JSON body of the shape: {\"orders\": [{...}, {...}]}, each object containing the fields used in this endpoint.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *OrderAmendOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderAmendOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| orderID | optional.String | Order ID | |
| origClOrdID | optional.String | Client Order ID. See POST /order. | |
| clOrdID | optional.String | Optional new Client Order ID, requires `origClOrdID`. | |
| simpleOrderQty | optional.Float64 | Optional order quantity in units of the underlying instrument (i.e. Bitcoin). | |
| orderQty | optional.Float32 | Optional order quantity in units of the instrument (i.e. contracts). | |
| simpleLeavesQty | optional.Float64 | Optional leaves quantity in units of the underlying instrument (i.e. Bitcoin). Useful for amending partially filled orders. | |
| leavesQty | optional.Float32 | Optional leaves quantity in units of the instrument (i.e. contracts). Useful for amending partially filled orders. | |
| price | optional.Float64 | Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders. | |
| stopPx | optional.Float64 | 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. | |
| pegOffsetValue | optional.Float64 | 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. | |
| text | optional.String | Optional amend annotation. e.g. 'Adjust skew'. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Order OrderAmendBulk(ctx, optional) Amend multiple orders for the same symbol.
Similar to POST /amend, but with multiple orders. application/json only. Ratelimited at 10%.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *OrderAmendBulkOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderAmendBulkOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| orders | optional.String | An array of orders. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Order OrderCancel(ctx, optional) Cancel order(s). Send multiple order IDs to cancel in bulk.
Either an orderID or a clOrdID must be provided.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *OrderCancelOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderCancelOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| orderID | optional.String | Order ID(s). | |
| clOrdID | optional.String | Client Order ID(s). See POST /order. | |
| text | optional.String | Optional cancellation annotation. e.g. 'Spread Exceeded'. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Order OrderCancelAll(ctx, optional) Cancels all of your orders.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *OrderCancelAllOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderCancelAllOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | optional.String | Optional symbol. If provided, only cancels orders for that symbol. | |
| filter | optional.String | Optional filter for cancellation. Use to only cancel some orders, e.g. `{"side": "Buy"}`. | |
| text | optional.String | Optional cancellation annotation. e.g. 'Spread Exceeded' |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
interface{} OrderCancelAllAfter(ctx, 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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| timeout | float64 | Timeout in ms. Set to 0 to cancel this timer. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Order OrderClosePosition(ctx, symbol, optional) 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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| symbol | string | Symbol of position to close. | |
| optional | *OrderClosePositionOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderClosePositionOpts struct
| Name | Type | Description | Notes |
|---|
price | optional.Float64| Optional limit price. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Order OrderGetOrders(ctx, optional) Get your orders.
To get open orders only, send {"open": true} in the filter param. See <a href="http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_D_68.html\">the FIX Spec for explanations of these fields.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *OrderGetOrdersOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderGetOrdersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | optional.String | Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`. | |
| filter | optional.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 for more details. | |
| columns | optional.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. | |
| count | optional.Float32 | Number of results to fetch. | [default to 100] |
| start | optional.Float32 | Starting point for results. | [default to 0] |
| reverse | optional.Bool | If true, will sort results newest first. | [default to false] |
| startTime | optional.Time | Starting date filter for results. | |
| endTime | optional.Time | Ending date filter for results. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Order OrderNew(ctx, symbol, optional) 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 ordTypes: * 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. * MarketWithLeftOverAsLimit: A market order that, after eating through the order book as far as permitted by available margin, will become a limit order. The difference between this type and Market only affects the behavior in thin books. Upon reaching the deepest possible price, if there is quantity left over, a Market order will cancel the remaining quantity. MarketWithLeftOverAsLimit will keep the remaining quantity in the books as a Limit. * 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. #### Execution Instructions The following execInsts 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. * AllOrNone: Valid only for hidden orders (displayQty: 0). Use to only execute if the entire order would fill. * 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'. * 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 agresssive will be amended first. * 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. * Note that a Close order without an orderQty requires a side, so that BitMEX knows if it should trigger above or below the stopPx. #### 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. * OUOA: One Updates the Other Absolute. Send a contingencyType of 'OneUpdatesTheOtherAbsolute' on the orders. Then as one order has a execution, other orders with the same clOrdLinkID will have their order quantity amended down by the execution quantity. * OUOP: One Updates the Other Proportional. Send a contingencyType of 'OneUpdatesTheOtherProportional' on the orders. Then as one order has a execution, other orders with the same clOrdLinkID will have their order quantity reduced proportionally by the fill percentage. #### 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 Send a simpleOrderQty instead of an orderQty to create an order denominated in the underlying currency. This is useful for opening up a position with 1 XBT of exposure without having to calculate how many contracts it is. #### Rate Limits See the Bulk Order Documentation if you need to place multiple orders at the same time. Bulk orders require fewer risk checks in the trading engine and thus are ratelimited at 1/10 the normal rate. You can also improve your reactivity to market movements while staying under your ratelimit by using the Amend and Amend Bulk endpoints. 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 \"def-456\" PUT /api/v1/order {\"origClOrdID\": \"abc-123\", \"clOrdID\": \"def-456\", \"leavesQty\": 1000}
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| symbol | string | Instrument symbol. e.g. 'XBTUSD'. | |
| optional | *OrderNewOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderNewOpts struct
| Name | Type | Description | Notes |
|---|
side | optional.String| Order side. Valid options: Buy, Sell. Defaults to 'Buy' unless `orderQty` or `simpleOrderQty` is negative. | simpleOrderQty | optional.Float64| Order quantity in units of the underlying instrument (i.e. Bitcoin). | orderQty | optional.Float32| Order quantity in units of the instrument (i.e. contracts). | price | optional.Float64| Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders. | displayQty | optional.Float32| Optional quantity to display in the book. Use 0 for a fully hidden order. | stopPx | optional.Float64| 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. | clOrdID | optional.String| Optional Client Order ID. This clOrdID will come back on the order and any related executions. | clOrdLinkID | optional.String| Optional Client Order Link ID for contingent orders. | pegOffsetValue | optional.Float64| 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. | pegPriceType | optional.String| Optional peg price type. Valid options: LastPeg, MidPricePeg, MarketPeg, PrimaryPeg, TrailingStopPeg. | ordType | optional.String| Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, MarketWithLeftOverAsLimit, Pegged. Defaults to 'Limit' when `price` is specified. Defaults to 'Stop' when `stopPx` is specified. Defaults to 'StopLimit' when `price` and `stopPx` are specified. | [default to Limit] timeInForce | optional.String| Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to 'GoodTillCancel' for 'Limit', 'StopLimit', 'LimitIfTouched', and 'MarketWithLeftOverAsLimit' orders. | execInst | optional.String| Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed. 'AllOrNone' instruction requires `displayQty` to be 0. 'MarkPrice', 'IndexPrice' or 'LastPrice' instruction valid for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. | contingencyType | optional.String| Optional contingency type for use with `clOrdLinkID`. Valid options: OneCancelsTheOther, OneTriggersTheOther, OneUpdatesTheOtherAbsolute, OneUpdatesTheOtherProportional. | text | optional.String| Optional order annotation. e.g. 'Take profit'. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Order OrderNewBulk(ctx, optional) Create multiple new orders for the same symbol.
This endpoint is used for placing bulk orders. Valid order types are Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, MarketWithLeftOverAsLimit, and Pegged. Each individual order object in the array should have the same properties as an individual POST /order call. This endpoint is much faster for getting many orders into the book at once. Because it reduces load on BitMEX systems, this endpoint is ratelimited at ceil(0.1 * orders). Submitting 10 orders via a bulk order call will only count as 1 request, 15 as 2, 32 as 4, and so on. For now, only application/json is supported on this endpoint.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *OrderNewBulkOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a OrderNewBulkOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| orders | optional.String | An array of orders. |
apiKey, apiNonce, apiSignature
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json, application/xml, text/xml, application/javascript, text/javascript
[Back to top] [Back to API list] [Back to Model list] [Back to README]