REST: Trade API

The base URL for endpoints described in this page of live trading API is https://api.cube.exchange/os/v0.

Definitions for requests and responses can be found in the Trade OpenAPI Document.

Further specifics for field enums, reject codes, etc. can be found in the Trade API Websocket Documentation.

Endpoints, authentication required

Endpoints in this section require REST Authentication headers. Note that only API keys with access-level WRITE are able to access any of these endpoints.

GET/orders

Query parameters

Response

200500

Body

application/json

result*object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/orders?subaccountId=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "result": {
    "orders": [
      {
        "cancelOnDisconnect": false,
        "clientOrderId": 1720791407860,
        "cumulativeQuantity": 0,
        "exchangeOrderId": 610000,
        "marketId": 100004,
        "orderQuantity": 3300,
        "orderType": 0,
        "price": 656000,
        "remainingQuantity": 3300,
        "restTime": 1720791407909233000,
        "side": 0,
        "subaccountId": 8,
        "timeInForce": 1
      },
      {
        "cancelOnDisconnect": false,
        "clientOrderId": 1721139361991,
        "cumulativeQuantity": 500,
        "exchangeOrderId": 630003,
        "marketId": 100022,
        "orderQuantity": 1500,
        "orderType": 0,
        "price": 1560,
        "remainingQuantity": 1000,
        "restTime": 1721139361998122000,
        "side": 1,
        "subaccountId": 8,
        "timeInForce": 1
      }
    ]
  }
}

DELETE/orders

Body

application/json

Cancel all resting orders, optionally limiting to a particular market and / or order book side.

subaccountId*integer (uint64)

The subaccount to cancel orders for.

requestId*integer (uint64)

A request ID that is echoed back on the MassCancelAck and individual CancelOrderAck's.

marketIdnullable integer (uint64)

If specified, only orders on the corresponding market will be canceled.

sidenullable integer (int32)

If specified, only orders with this side will be canceled.

Response

200500

Body

application/json

result*object

Mass-cancel-ack confirms a mass-cancel request. If reason is set, the mass cancel was not applied and there are no affected orders. Individual CancelOrderAck's will be sent for each order that was affected.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/orders', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "marketId": 100004,
      "requestId": 1721194173903564000,
      "side": 0,
      "subaccountId": 8
    }),
});
const data = await response.json();

Response

200500

{
  "result": {
    "msgSeqNum": 10,
    "reason": null,
    "requestId": 1721194173903564000,
    "subaccountId": 8,
    "totalAffectedOrders": 3,
    "transactTime": 1721564617171865000
  }
}

POST/order

Body

application/json

Place a new order.

clientOrderId*integer (uint64)

A unique order ID assigned by the client for this order. The ID must be unique among open orders by this subaccount.

requestId*integer (uint64)

A request ID that is echoed back on the NewOrderAck or NewOrderReject

marketId*integer (uint64)

pricenullable integer (uint64)

quantity*integer (uint64)

side*integer (int32)

timeInForce*integer (int32)

orderType*integer (int32)

subaccountId*integer (uint64)

The subaccount to place this order on. This subaccount must be writable by the API key specified in the Credentials message.

selfTradePreventionnullable integer (int32)

postOnly*integer (int32)

cancelOnDisconnect*boolean

If true, this order will be automatically cancelled after the closure of the network connection between Cube's servers and the client that placed the order.

If the client initiates the disconnect or network instability drops the connection, the order will be cancelled when Cube's servers recognize the disconnection.

In the event of a server-side disconnect that causes a halt in trading, such as scheduled downtime, the order will be cancelled before trading resumes.

Response

200500

Body

application/json

result*one of

objectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cancelOnDisconnect": false,
      "clientOrderId": 1721188848244274000,
      "marketId": 100004,
      "orderType": 0,
      "postOnly": 0,
      "price": 656000,
      "quantity": 3300,
      "requestId": 1721188848288393000,
      "selfTradePrevention": 1,
      "side": 0,
      "subaccountId": 8,
      "timeInForce": 1
    }),
});
const data = await response.json();

Response

200500

{
  "result": {
    "Ack": {
      "cancelOnDisconnect": false,
      "clientOrderId": 1721188848244274000,
      "exchangeOrderId": 630005,
      "marketId": 100004,
      "msgSeqNum": 10,
      "orderType": 0,
      "price": 656000,
      "quantity": 3300,
      "requestId": 1721188848288393000,
      "side": 0,
      "subaccountId": 8,
      "timeInForce": 1,
      "transactTime": 1721193327116302000
    }
  }
}

DELETE/order

Body

application/json

Cancel a resting order. Note that this can be done before the order is acknowledged (an aggressive cancel) since the identifying field is the client_order_id.

marketId*integer (uint64)

clientOrderId*integer (uint64)

The order ID specified by the client on the NewOrder request.

requestId*integer (uint64)

A request ID that is echoed back on the CancelOrderAck or CancelOrderReject

subaccountId*integer (uint64)

The subaccount that the NewOrder was placed on.

Response

200500

Body

application/json

result*one of

objectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/order', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientOrderId": 1721188848244274000,
      "marketId": 100004,
      "requestId": 1721188848288393000,
      "subaccountId": 8
    }),
});
const data = await response.json();

Response

200500

{
  "result": {
    "Ack": {
      "clientOrderId": 1721188848244274000,
      "exchangeOrderId": 630005,
      "marketId": 100004,
      "msgSeqNum": 10,
      "reason": 2,
      "requestId": 1721188848288393000,
      "subaccountId": 8,
      "transactTime": 1721188848329501000
    }
  }
}

PATCH/order

Body

application/json

Modify a resting order. - If the newPrice and the current resting order's price is the same, and newQuantity is not greater, then the modify is considered a modify down, and the FIFO queue priority is maintained. Otherwise, the modify-order request is treated as an atomic cancel-replace and the replacement order is placed at the end of the FIFO queue for the new price level. - If post-only is specified and the replacement order would trade, then the request is rejected and the current resting order remains resting.

Currently, in-flight-mitigation (IFM) is always enabled. That is, the cumulative fill qty is subtracted from newQuantity to calculate the new resting quantity. For example:

text | Resting | Filled ---------+---------+-------- New 5 | 5 | 0 Fill 2 | 3 | 2 Modify 4 | 2 | 2

The post-modify quantity will be newQuantity - filled = 4 - 2 = 2.

Regardless of IFM, the invariant for order quantity is that quantity = remaining_quantity + cumulative_quantity.

marketId*integer (uint64)

clientOrderId*integer (uint64)

The order ID specified by the client on the NewOrder request.

requestId*integer (uint64)

A request ID that is echoed back on the ModifyOrderAck or ModifyOrderReject

newPrice*integer (uint64)

newQuantity*integer (uint64)

subaccountId*integer (uint64)

The subaccount that the NewOrder was placed on.

selfTradePreventionnullable integer (int32)

postOnly*integer (int32)

Response

200500

Body

application/json

result*one of

objectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/order', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientOrderId": 1721212575078893000,
      "marketId": 100004,
      "newPrice": 656000,
      "newQuantity": 3300,
      "postOnly": 0,
      "requestId": 1721212575263679000,
      "selfTradePrevention": 1,
      "subaccountId": 8
    }),
});
const data = await response.json();

Response

200500

{
  "result": {
    "Ack": {
      "clientOrderId": 1721212575078893000,
      "cumulativeQuantity": 0,
      "exchangeOrderId": 630009,
      "marketId": 100004,
      "msgSeqNum": 21,
      "price": 656000,
      "quantity": 3300,
      "remainingQuantity": 3300,
      "requestId": 1721212575263679000,
      "subaccountId": 8,
      "transactTime": 1721212575309118000
    }
  }
}

GET/positions

Query parameters

Response

200500

Body

application/json

result*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/positions?subaccountId=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "result": [
    {
      "assetId": 100004,
      "available": "12780000",
      "total": "13050000"
    }
  ]
}