Error

A valid request URL is required to generate request examples

{
  "order": {
    "orderId": "<order-id>",
    "clientOrderId": "q-20270115-000123",
    "instrumentId": "<instrument-id>",
    "side": "BUY",
    "type": "LIMIT",
    "price": {
      "units": "105",
      "decimals": 0
    },
    "quantity": {
      "units": "2",
      "decimals": 0
    },
    "requestedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "acceptedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "filledQuantity": {
      "units": "1",
      "decimals": 0
    },
    "remainingQuantity": {
      "units": "1",
      "decimals": 0
    },
    "cancelledQuantity": {
      "units": "0",
      "decimals": 0
    },
    "reductionReason": null,
    "status": "PARTIALLY_FILLED",
    "cancelReason": null,
    "createdAtMs": "1800000000500",
    "updatedAtMs": "1800000004000",
    "filledAtMs": null,
    "cancelledAtMs": null
  },
  "duplicate": true,
  "serverTimeMs": "1800000000510"
}

{
  "order": {
    "orderId": "<order-id>",
    "clientOrderId": "q-20270115-000123",
    "instrumentId": "<instrument-id>",
    "side": "BUY",
    "type": "LIMIT",
    "price": {
      "units": "105",
      "decimals": 0
    },
    "quantity": {
      "units": "2",
      "decimals": 0
    },
    "requestedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "acceptedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "filledQuantity": {
      "units": "1",
      "decimals": 0
    },
    "remainingQuantity": {
      "units": "1",
      "decimals": 0
    },
    "cancelledQuantity": {
      "units": "0",
      "decimals": 0
    },
    "reductionReason": null,
    "status": "PARTIALLY_FILLED",
    "cancelReason": null,
    "createdAtMs": "1800000000500",
    "updatedAtMs": "1800000004000",
    "filledAtMs": null,
    "cancelledAtMs": null
  },
  "duplicate": false,
  "serverTimeMs": "1800000000510"
}

{
  "error": "INVALID_PRICE",
  "message": "…"
}

{
  "error": "INVALID_API_KEY",
  "message": "…"
}

{
  "error": "TRADING_DISABLED",
  "message": "…"
}

{
  "error": "UNKNOWN_INSTRUMENT",
  "message": "…"
}

{
  "error": "IDEMPOTENCY_CONFLICT",
  "message": "…"
}

{
  "error": "RISK_LIMIT",
  "message": "…",
  "limit": "MAX_OPEN_EXPOSURE"
}

{
  "error": "RATE_LIMITED",
  "message": "Too many requests. Retry after the indicated delay."
}

{
  "error": "INTERNAL",
  "message": "…"
}

Trading

Place order

Place a good-till-cancelled limit order. Requires mm:trade and trading to be available for your account. The full quantity is accepted or the order is refused; D1 never resizes an order. A refused order creates nothing. Fills from the placement are on /executions when the response arrives.

If the result is unknown (timeout, network error, 5xx), resend the identical request with the same clientOrderId. Never re-send the same intent under a new clientOrderId.

Guide: Orders, Trading Rules.

Error

A valid request URL is required to generate request examples

{
  "order": {
    "orderId": "<order-id>",
    "clientOrderId": "q-20270115-000123",
    "instrumentId": "<instrument-id>",
    "side": "BUY",
    "type": "LIMIT",
    "price": {
      "units": "105",
      "decimals": 0
    },
    "quantity": {
      "units": "2",
      "decimals": 0
    },
    "requestedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "acceptedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "filledQuantity": {
      "units": "1",
      "decimals": 0
    },
    "remainingQuantity": {
      "units": "1",
      "decimals": 0
    },
    "cancelledQuantity": {
      "units": "0",
      "decimals": 0
    },
    "reductionReason": null,
    "status": "PARTIALLY_FILLED",
    "cancelReason": null,
    "createdAtMs": "1800000000500",
    "updatedAtMs": "1800000004000",
    "filledAtMs": null,
    "cancelledAtMs": null
  },
  "duplicate": true,
  "serverTimeMs": "1800000000510"
}

{
  "order": {
    "orderId": "<order-id>",
    "clientOrderId": "q-20270115-000123",
    "instrumentId": "<instrument-id>",
    "side": "BUY",
    "type": "LIMIT",
    "price": {
      "units": "105",
      "decimals": 0
    },
    "quantity": {
      "units": "2",
      "decimals": 0
    },
    "requestedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "acceptedQuantity": {
      "units": "2",
      "decimals": 0
    },
    "filledQuantity": {
      "units": "1",
      "decimals": 0
    },
    "remainingQuantity": {
      "units": "1",
      "decimals": 0
    },
    "cancelledQuantity": {
      "units": "0",
      "decimals": 0
    },
    "reductionReason": null,
    "status": "PARTIALLY_FILLED",
    "cancelReason": null,
    "createdAtMs": "1800000000500",
    "updatedAtMs": "1800000004000",
    "filledAtMs": null,
    "cancelledAtMs": null
  },
  "duplicate": false,
  "serverTimeMs": "1800000000510"
}

{
  "error": "INVALID_PRICE",
  "message": "…"
}

{
  "error": "INVALID_API_KEY",
  "message": "…"
}

{
  "error": "TRADING_DISABLED",
  "message": "…"
}

{
  "error": "UNKNOWN_INSTRUMENT",
  "message": "…"
}

{
  "error": "IDEMPOTENCY_CONFLICT",
  "message": "…"
}

{
  "error": "RISK_LIMIT",
  "message": "…",
  "limit": "MAX_OPEN_EXPOSURE"
}

{
  "error": "RATE_LIMITED",
  "message": "Too many requests. Retry after the indicated delay."
}

{
  "error": "INTERNAL",
  "message": "…"
}

Authorizations

Authorization

string

header

required

Authorization: Bearer . Scopes: mm:read (GET endpoints), mm:trade (POST endpoints).

Scopes

mm:trade

Body

application/json

clientOrderId

string

required

Your identifier for this order, unique per account forever. Retrying with the same clientOrderId and the same terms returns the existing order.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$

instrumentId

string

required

The market.

side

enum<string>

required

SELL is sell-to-close only.

Available options:

BUY,

SELL

type

enum<string>

required

Available options:

LIMIT

price

object

required

Limit price. A multiple of priceTick, with the same decimals. units is a positive integer string.

Show child attributes

quantity

object

required

Contracts. A multiple of quantityStep, with the same decimals. units is a positive integer string.

Show child attributes

Response

Duplicate: this clientOrderId already has an order with the same terms. Nothing new was created.

order

object

required

Show child attributes

duplicate

boolean

required

true when this clientOrderId already had an order with the same terms; order is its current state.

serverTimeMs

string

required

D1 server time, Unix milliseconds, as a decimal string.

Example:

"1800000000510"

Overview

Market Maker API

Place order

Authorizations

Scopes

Body

Response