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

/orders

Query parameters

subaccountIdinteger · uint64required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/orders?subaccountId=1'

200

500

200

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

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 | nullable

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

sideinteger · int32 | nullable

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/orders' \
  --header 'Content-Type: application/json' \
  --data '{
    "marketId": 100004,
    "requestId": 1721194173903564000,
    "side": 0,
    "subaccountId": 8
  }'

200

500

200

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

post

/order

Body

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 | nullable

quantityinteger · uint64 | nullable

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 | nullable

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 | nullable

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/order' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

200

500

200

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

/order

Body

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/order' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientOrderId": 1721188848244274000,
    "marketId": 100004,
    "requestId": 1721188848288393000,
    "subaccountId": 8
  }'

200

500

200

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

patch

/order

Body

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 | nullable

postOnlyinteger · int32required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/order' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientOrderId": 1721212575078893000,
    "marketId": 100004,
    "newPrice": 656000,
    "newQuantity": 3300,
    "postOnly": 0,
    "requestId": 1721212575263679000,
    "selfTradePrevention": 1,
    "subaccountId": 8
  }'

200

500

200

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

subaccountIdinteger · uint64required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/positions?subaccountId=1'

200

500

200

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