Skip to main content

Endpoints

EndpointMethodDescriptionRate Limit
/v1/ordersPOSTPlace order10 req/sec
/v1/order/{id}/cancelPOSTCancel order10 req/sec
/v1/orders/open/cancelPOSTCancel all open orders5 req/sec
/v1/orders/openGETList open orders5 req/min
/v1/order/{id}GETGet order details5 req/min
Authentication: API key signature

Order Types

Market Orders

Execute immediately at the best available price. Request:
POST /v1/orders
X-API-Key: {api_key}
X-API-Signature: {signature}
Content-Type: application/json

{
  "instrument_id": "inst_abc123",
  "side": "buy",
  "type": "market",
  "quantity": 100
}

Limit Orders

Execute only at the specified price or better. Request:
POST /v1/orders
X-API-Key: {api_key}
X-API-Signature: {signature}
Content-Type: application/json

{
  "instrument_id": "inst_abc123",
  "side": "buy",
  "type": "limit",
  "quantity": 100,
  "price": 0.55
}
Response:
{
  "id": "ord_xyz789",
  "instrument_id": "inst_abc123",
  "side": "buy",
  "type": "limit",
  "quantity": 100,
  "price": 0.55,
  "status": "open",
  "created_at": "2026-01-13T10:00:00Z"
}

Cancel Order

Cancel a specific open order. To change an order, cancel it and place a new one (order modification is not yet available). Request:
POST /v1/order/{order_id}/cancel
X-API-Key: {api_key}
X-API-Signature: {signature}
Response:
{
  "success": true,
  "order_id": "ord_xyz789",
  "status": "cancelled"
}

Cancel All Open Orders

Cancel all open orders for your account. Request:
POST /v1/orders/open/cancel
X-API-Key: {api_key}
X-API-Signature: {signature}
Response:
{
  "success": true,
  "cancelled_count": 5,
  "order_ids": ["ord_123", "ord_456", "ord_789"]
}

List Open Orders

Get all currently open orders. Request:
GET /v1/orders/open
X-API-Key: {api_key}
X-API-Signature: {signature}
Response:
{
  "orders": [
    {
      "id": "ord_xyz789",
      "instrument_id": "inst_abc123",
      "side": "buy",
      "type": "limit",
      "quantity": 100,
      "price": 0.55,
      "filled_quantity": 25,
      "status": "partially_filled",
      "created_at": "2026-01-13T10:00:00Z"
    }
  ]
}

Get Order Details

Get details for a specific order. Request:
GET /v1/order/{order_id}
X-API-Key: {api_key}
X-API-Signature: {signature}
Response:
{
  "id": "ord_xyz789",
  "instrument_id": "inst_abc123",
  "side": "buy",
  "type": "limit",
  "quantity": 100,
  "price": 0.55,
  "filled_quantity": 100,
  "status": "filled",
  "created_at": "2026-01-13T10:00:00Z",
  "filled_at": "2026-01-13T10:05:00Z",
  "fills": [
    {
      "quantity": 50,
      "price": 0.55,
      "timestamp": "2026-01-13T10:02:00Z"
    },
    {
      "quantity": 50,
      "price": 0.55,
      "timestamp": "2026-01-13T10:05:00Z"
    }
  ]
}

Order Lifecycle

Orders progress through these states:
StatusDescription
openOrder is active and waiting to be filled
partially_filledOrder is partially executed
filledOrder is completely executed
cancelledOrder was cancelled before being filled
rejectedOrder was rejected (insufficient funds, invalid price, etc.)