REST 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 Authentication headers. Note that only API keys with access-level WRITE are able to access any of these endpoints.

get

Query parameters

subaccountIdinteger · uint64Required

Responses

200Success

application/json

500

An error was encountered while processing the request.

application/json

get

HTTPcURLJavaScriptPython

GET /orders?subaccountId=1 HTTP/1.1
Host: 
Accept: */*

{
  "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

Body

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

subaccountIdinteger · uint64Required

The subaccount to cancel orders for.

requestIdinteger · uint64Required

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

marketIdinteger · uint64 | nullableOptional

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

sideinteger · int32 | nullableOptional

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

Responses

200Success

application/json

500

An error was encountered while processing the request.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /orders HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "marketId": 100004,
  "requestId": 1721194173903564000,
  "side": 0,
  "subaccountId": 8
}

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

post

Body

Place a new order.

Execution details: - For market orders, exactly one of quantity or quote_quantity must be specified. - For MARKET_WITH_PROTECTION, if price is specified, it will override the default protection price. - Matching will stop upon reaching the protection price, or quantity (or quote_quantity) filled. - When specifying quote_quantity, the order is considered 'fully filled' when there is insufficient remaining quote quantity to fill 1 lot at the next trade price. In that case, there will not be a CancelOrderAck published.

clientOrderIdinteger · uint64Required

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

requestIdinteger · uint64Required

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

marketIdinteger · uint64Required

priceinteger · uint64 | nullableOptional

quantityinteger · uint64 | nullableOptional

Required for LIMIT orders.

sideinteger · int32Required

timeInForceinteger · int32Required

orderTypeinteger · int32Required

subaccountIdinteger · uint64Required

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

selfTradePreventioninteger · int32 | nullableOptional

postOnlyinteger · int32Required

cancelOnDisconnectbooleanRequired

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.

quoteQuantityinteger · uint64 | nullableOptional

The quantity of the quote asset that the user wants to spend (for a BID) or receive (for an ASK). For limit orders, this is immediately converted to a base quantity using the provided price. For market orders, this is the maximum quantity that will be executed.

Note that lot size rules will be respected, and the actual quantity executed will be expressed in base quantity units.

Responses

200Success

application/json

500

An error was encountered while processing the request.

application/json

post

HTTPcURLJavaScriptPython

POST /order HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "cancelOnDisconnect": false,
  "clientOrderId": 1721188848244274000,
  "marketId": 100004,
  "orderType": 0,
  "postOnly": 0,
  "price": 656000,
  "quantity": 3300,
  "quoteQuantity": null,
  "requestId": 1721188848288393000,
  "selfTradePrevention": 1,
  "side": 0,
  "subaccountId": 8,
  "timeInForce": 1
}

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

delete

Body

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.

marketIdinteger · uint64Required

clientOrderIdinteger · uint64Required

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

requestIdinteger · uint64Required

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

subaccountIdinteger · uint64Required

The subaccount that the NewOrder was placed on.

Responses

200Success

application/json

500

An error was encountered while processing the request.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /order HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "clientOrderId": 1721188848244274000,
  "marketId": 100004,
  "requestId": 1721188848288393000,
  "subaccountId": 8
}

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

patch

Body

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.

marketIdinteger · uint64Required

clientOrderIdinteger · uint64Required

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

requestIdinteger · uint64Required

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

newPriceinteger · uint64Required

newQuantityinteger · uint64Required

subaccountIdinteger · uint64Required

The subaccount that the NewOrder was placed on.

selfTradePreventioninteger · int32 | nullableOptional

postOnlyinteger · int32Required

Responses

200Success

application/json

500

An error was encountered while processing the request.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /order HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "clientOrderId": 1721212575078893000,
  "marketId": 100004,
  "newPrice": 656000,
  "newQuantity": 3300,
  "postOnly": 0,
  "requestId": 1721212575263679000,
  "selfTradePrevention": 1,
  "subaccountId": 8
}

{
  "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

Query parameters

subaccountIdinteger · uint64Required

Responses

200Success

application/json

500

An error was encountered while processing the request.

application/json

get

HTTPcURLJavaScriptPython

GET /positions?subaccountId=1 HTTP/1.1
Host: 
Accept: */*

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