> ## Documentation Index > Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Order Creation Stream > Create, modify, and cancel orders, with fill notifications. This stream is active on the `orders` subscription, which is on by default when you connect. It allows you to create, modify, and cancel orders, and receive fill notifications. #### Multi-Step Responses Order actions typically produce more than one message on this stream: 1. An **acknowledgment** (`statusCode: 202`) confirming the request was received and is being processed — `cancelOrder` skips this step and goes straight to confirmation or error 2. A **confirmation** (`statusCode: 200`) once the action has taken effect, or an **error** if it failed #### Notifications `completeFillOrder` and `partialFillOrder` are pushed as your orders execute. ## AsyncAPI ````yaml latest/options/asyncapi/options-ws.yaml orderCreationStream id: orderCreationStream title: Order Creation Stream description: > Active on the `orders` subscription, which is on by default when you connect. Create, modify, and cancel orders, and receive fill notifications. servers: - id: sandbox protocol: wss host: ws.sandbox.rails.xyz bindings: [] variables: [] address: '?product=options&market={market}' parameters: - id: market jsonSchema: type: string description: >- Option contract name (e.g. `BTC-19JUN26-62000-C`), or `ALL` to connect across all contracts. default: BTC-19JUN26-62000-C description: >- Option contract name (e.g. `BTC-19JUN26-62000-C`), or `ALL` to connect across all contracts. type: string required: true deprecated: false bindings: [] operations: - &ref_3 id: createOrder title: Create order description: Create a limit or market order. type: receive messages: - &ref_10 id: createOrderRequest contentType: application/json payload: - name: Create Order type: object properties: - name: message type: string description: Always `createOrder`. required: true - name: content type: object required: true properties: - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: market type: string description: >- Market name, only required when connecting with `market=ALL` required: false - name: price type: string description: Limit price; for market orders, the expected price required: true - name: quantity type: string description: Order quantity required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: postOnly type: boolean description: Maker-only flag; limit orders only required: false - name: reduceOnly type: boolean description: Restrict the order to reducing an existing position required: false - name: maxSlippage type: string description: Market orders only; `0 - 1` inclusive. `0` behaves as IOC required: false headers: [] jsonPayloadSchema: type: object properties: message: type: string description: Always `createOrder`. x-parser-schema-id: content: type: object properties: clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: market: type: string description: Market name, only required when connecting with `market=ALL` x-parser-schema-id: price: type: string description: Limit price; for market orders, the expected price x-parser-schema-id: quantity: type: string description: Order quantity x-parser-schema-id: orderType: type: string enum: - buy - sell description: Order side x-parser-schema-id: tradeType: type: string enum: - limit - market description: Order type x-parser-schema-id: postOnly: type: boolean description: Maker-only flag; limit orders only x-parser-schema-id: reduceOnly: type: boolean description: Restrict the order to reducing an existing position x-parser-schema-id: maxSlippage: type: string description: Market orders only; `0 - 1` inclusive. `0` behaves as IOC x-parser-schema-id: required: - price - quantity - orderType - tradeType x-parser-schema-id: required: - message - content x-parser-schema-id: title: Create Order example: |- { "message": "createOrder", "content": { "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef", "market": "BTC-3JUL26-55000-C", "price": "6400", "quantity": "1", "orderType": "buy", "tradeType": "limit", "postOnly": false } } bindings: [] extensions: - id: x-parser-unique-object-id value: createOrderRequest bindings: [] extensions: &ref_1 - id: x-parser-unique-object-id value: orderCreationStream - &ref_6 id: createOrderResult title: Create order result description: >- Acknowledgment (202), confirmation (200), or error response to `createOrder`. type: send messages: - &ref_13 id: createOrderAck contentType: application/json payload: - name: Create Order — Acknowledgment type: object properties: - name: resultType type: string description: Always `createOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `202`. required: true - name: body type: string description: Always `order received`. required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `createOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `202`. x-parser-schema-id: body: type: string description: Always `order received`. x-parser-schema-id: order: &ref_0 type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. properties: market: type: string description: Contract name x-parser-schema-id: orderId: type: string description: Unique order identifier x-parser-schema-id: orderType: type: string enum: - buy - sell description: Order side x-parser-schema-id: tradeType: type: string enum: - limit - market description: Order type x-parser-schema-id: price: type: string description: Order price x-parser-schema-id: quantity: type: string description: Order quantity x-parser-schema-id: filledQuantity: type: string description: Quantity filled so far x-parser-schema-id: leverage: type: string description: Leverage — always `0` for options x-parser-schema-id: orderStatus: type: string enum: - pending - open - cancelled - filled - rejected description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected x-parser-schema-id: postOnly: type: boolean description: Maker-only flag x-parser-schema-id: createdAt: type: integer description: Creation time (ms since epoch) x-parser-schema-id: updatedAt: type: integer description: Last update time (ms since epoch) x-parser-schema-id: clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - market - orderId - orderType - tradeType - price - quantity - filledQuantity - leverage - orderStatus - postOnly - createdAt - updatedAt x-parser-schema-id: Order clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Create Order — Acknowledgment example: |- { "resultType": "createOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 202, "body": "order received", "order": { "market": "BTC-3JUL26-55000-C", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W", "orderType": "buy", "tradeType": "limit", "price": "6400", "quantity": "1", "filledQuantity": "0", "leverage": "0", "orderStatus": "pending", "postOnly": false, "createdAt": 1783053411143, "updatedAt": 1783053411171, "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef" }, "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef" } } bindings: [] extensions: - id: x-parser-unique-object-id value: createOrderAck - &ref_14 id: createOrderConfirmation contentType: application/json payload: - name: Create Order — Confirmation type: object properties: - name: resultType type: string description: Always `createOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `200`. required: true - name: body type: string description: Always `order placed`. required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `createOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `200`. x-parser-schema-id: body: type: string description: Always `order placed`. x-parser-schema-id: order: *ref_0 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Create Order — Confirmation example: |- { "resultType": "createOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 200, "body": "order placed", "order": { "market": "BTC-3JUL26-55000-C", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W", "orderType": "buy", "tradeType": "limit", "price": "6400", "quantity": "1", "filledQuantity": "0", "leverage": "0", "orderStatus": "open", "postOnly": false, "createdAt": 1783053411143, "updatedAt": 1783053411174, "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef" }, "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef" } } bindings: [] extensions: - id: x-parser-unique-object-id value: createOrderConfirmation - &ref_15 id: createOrderError contentType: application/json payload: - name: Create Order — Error type: object properties: - name: resultType type: string description: Always `createOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Error status, e.g. `400` required: true - name: body type: string description: Status message required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: false properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: error type: object required: true properties: - name: slug type: string description: Machine-readable error slug required: true - name: code type: string description: Error code required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `createOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Error status, e.g. `400` x-parser-schema-id: body: type: string description: Status message x-parser-schema-id: order: *ref_0 error: &ref_2 type: object properties: slug: type: string description: Machine-readable error slug x-parser-schema-id: code: type: string description: Error code x-parser-schema-id: required: - slug - code x-parser-schema-id: ErrorDetail clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - error x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Create Order — Error example: |- { "resultType": "createOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 400, "body": "self trade not allowed", "order": { "market": "BTC-3JUL26-55000-C", "orderId": "01KWMXCQCSQC1MN9NJ30TYZPKJ", "orderType": "sell", "tradeType": "limit", "price": "6700", "quantity": "1", "filledQuantity": "0", "leverage": "0", "orderStatus": "rejected", "postOnly": true, "createdAt": 1783113342363, "updatedAt": 1783113342365, "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef" }, "error": { "code": "6000", "slug": "ORDER_REJECTED" }, "clientRequestId": "3e2c3bb4-be3f-4d05-9133-51d3a27b74ef" } } bindings: [] extensions: - id: x-parser-unique-object-id value: createOrderError bindings: [] extensions: *ref_1 - &ref_4 id: modifyOrder title: Modify order description: Modify the price and/or quantity of an existing order. type: receive messages: - &ref_11 id: modifyOrderRequest contentType: application/json payload: - name: Modify Order type: object properties: - name: message type: string description: Always `modifyOrder`. required: true - name: content type: object required: true properties: - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: market type: string description: >- Market name, only required when connecting with `market=ALL` required: false - name: orderId type: string description: Unique identifier for the original order required: true - name: price type: string description: New order price required: true - name: quantity type: string description: New order quantity required: true headers: [] jsonPayloadSchema: type: object properties: message: type: string description: Always `modifyOrder`. x-parser-schema-id: content: type: object properties: clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: market: type: string description: Market name, only required when connecting with `market=ALL` x-parser-schema-id: orderId: type: string description: Unique identifier for the original order x-parser-schema-id: price: type: string description: New order price x-parser-schema-id: quantity: type: string description: New order quantity x-parser-schema-id: required: - orderId - price - quantity x-parser-schema-id: required: - message - content x-parser-schema-id: title: Modify Order example: |- { "message": "modifyOrder", "content": { "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7", "market": "BTC-3JUL26-55000-C", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W", "price": "6300", "quantity": "1" } } bindings: [] extensions: - id: x-parser-unique-object-id value: modifyOrderRequest bindings: [] extensions: *ref_1 - &ref_7 id: modifyOrderResult title: Modify order result description: >- Acknowledgment (202), confirmation (200), or error response to `modifyOrder`. type: send messages: - &ref_16 id: modifyOrderAck contentType: application/json payload: - name: Modify Order — Acknowledgment type: object properties: - name: resultType type: string description: Always `modifyOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `202`. required: true - name: body type: string description: Always `order received`. required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `modifyOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `202`. x-parser-schema-id: body: type: string description: Always `order received`. x-parser-schema-id: order: *ref_0 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Modify Order — Acknowledgment example: |- { "resultType": "modifyOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 202, "body": "order received", "order": { "market": "BTC-3JUL26-55000-C", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W", "orderType": "buy", "tradeType": "limit", "price": "6300", "quantity": "1", "filledQuantity": "0", "leverage": "0", "orderStatus": "pending", "postOnly": false, "createdAt": 1783053411143, "updatedAt": 1783053548624, "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7" }, "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7" } } bindings: [] extensions: - id: x-parser-unique-object-id value: modifyOrderAck - &ref_17 id: modifyOrderConfirmation contentType: application/json payload: - name: Modify Order — Confirmation type: object properties: - name: resultType type: string description: Always `modifyOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `200`. required: true - name: body type: string description: Always `order placed`. required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `modifyOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `200`. x-parser-schema-id: body: type: string description: Always `order placed`. x-parser-schema-id: order: *ref_0 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Modify Order — Confirmation example: |- { "resultType": "modifyOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 200, "body": "order placed", "order": { "market": "BTC-3JUL26-55000-C", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W", "orderType": "buy", "tradeType": "limit", "price": "6300", "quantity": "1", "filledQuantity": "0", "leverage": "0", "orderStatus": "open", "postOnly": false, "createdAt": 1783053411143, "updatedAt": 1783053548626, "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7" }, "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7" } } bindings: [] extensions: - id: x-parser-unique-object-id value: modifyOrderConfirmation - &ref_18 id: modifyOrderError contentType: application/json payload: - name: Modify Order — Error type: object properties: - name: resultType type: string description: Always `modifyOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Error status, e.g. `404` required: true - name: body type: string description: Status message required: true - name: error type: object required: true properties: - name: slug type: string description: Machine-readable error slug required: true - name: code type: string description: Error code required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `modifyOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Error status, e.g. `404` x-parser-schema-id: body: type: string description: Status message x-parser-schema-id: error: *ref_2 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - error x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Modify Order — Error example: |- { "resultType": "modifyOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 404, "body": "order not found", "error": { "code": "3003", "slug": "MODIFY_ORDER_NOT_FOUND_ERROR" }, "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7" } } bindings: [] extensions: - id: x-parser-unique-object-id value: modifyOrderError bindings: [] extensions: *ref_1 - &ref_5 id: cancelOrder title: Cancel order description: Cancel an order by ID. type: receive messages: - &ref_12 id: cancelOrderRequest contentType: application/json payload: - name: Cancel Order By ID type: object properties: - name: message type: string description: Always `cancelOrder`. required: true - name: content type: object required: true properties: - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: market type: string description: >- Market name, only required when connecting with `market=ALL` required: false - name: orderId type: string description: Target order identifier required: true - name: cancelBy type: string description: Cancellation mode; currently `orderId` required: true headers: [] jsonPayloadSchema: type: object properties: message: type: string description: Always `cancelOrder`. x-parser-schema-id: content: type: object properties: clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: market: type: string description: Market name, only required when connecting with `market=ALL` x-parser-schema-id: orderId: type: string description: Target order identifier x-parser-schema-id: cancelBy: type: string description: Cancellation mode; currently `orderId` x-parser-schema-id: required: - orderId - cancelBy x-parser-schema-id: required: - message - content x-parser-schema-id: title: Cancel Order By ID example: |- { "message": "cancelOrder", "content": { "clientRequestId": "b56692f8-4322-411d-846f-268c01cd4fa9", "market": "BTC-3JUL26-55000-C", "cancelBy": "orderId", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W" } } bindings: [] extensions: - id: x-parser-unique-object-id value: cancelOrderRequest bindings: [] extensions: *ref_1 - &ref_8 id: cancelOrderResult title: Cancel order result description: Confirmation (200) or error response to `cancelOrder`. type: send messages: - &ref_19 id: cancelOrderConfirmation contentType: application/json payload: - name: Cancel Order — Confirmation type: object properties: - name: resultType type: string description: Always `cancelOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `200`. required: true - name: body type: string description: Always `order cancelled`. required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `cancelOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `200`. x-parser-schema-id: body: type: string description: Always `order cancelled`. x-parser-schema-id: order: *ref_0 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Cancel Order — Confirmation example: |- { "resultType": "cancelOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 200, "body": "order cancelled", "order": { "market": "BTC-3JUL26-55000-C", "orderId": "01KWK47RT6A4DD1TCQE662QJ3W", "orderType": "buy", "tradeType": "limit", "price": "6300", "quantity": "1", "filledQuantity": "0", "leverage": "0", "orderStatus": "cancelled", "postOnly": false, "createdAt": 1783053411143, "updatedAt": 1783053687411, "clientRequestId": "b56692f8-4322-411d-846f-268c01cd4fa9" }, "clientRequestId": "b56692f8-4322-411d-846f-268c01cd4fa9" } } bindings: [] extensions: - id: x-parser-unique-object-id value: cancelOrderConfirmation - &ref_20 id: cancelOrderError contentType: application/json payload: - name: Cancel Order — Error type: object properties: - name: resultType type: string description: Always `cancelOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Error status, e.g. `404` required: true - name: body type: string description: Status message required: true - name: error type: object required: true properties: - name: slug type: string description: Machine-readable error slug required: true - name: code type: string description: Error code required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `cancelOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Error status, e.g. `404` x-parser-schema-id: body: type: string description: Status message x-parser-schema-id: error: *ref_2 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - error x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Cancel Order — Error example: |- { "resultType": "cancelOrder", "market": "BTC-3JUL26-55000-C", "data": { "statusCode": 404, "body": "order not found", "error": { "code": "0007", "slug": "NOT_FOUND" }, "clientRequestId": "b56692f8-4322-411d-846f-268c01cd4fa9" } } bindings: [] extensions: - id: x-parser-unique-object-id value: cancelOrderError bindings: [] extensions: *ref_1 - &ref_9 id: orderFilled title: Order filled description: Pushed when an order is completely or partially filled. type: send messages: - &ref_21 id: completeFillNotification contentType: application/json payload: - name: Order Filled — Complete Fill type: object properties: - name: resultType type: string description: Always `completeFillOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `200`. required: true - name: body type: string description: Status message required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `completeFillOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `200`. x-parser-schema-id: body: type: string description: Status message x-parser-schema-id: order: *ref_0 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Order Filled — Complete Fill example: |- { "resultType": "completeFillOrder", "market": "BTC-10JUL26-55000-C", "data": { "statusCode": 200, "body": "order filled", "order": { "market": "BTC-10JUL26-55000-C", "orderId": "01KWVNC7T8XWVHGKY00A9TD0YG", "orderType": "buy", "tradeType": "market", "price": "7029.8", "quantity": "1", "filledQuantity": "1", "leverage": "0", "orderStatus": "filled", "postOnly": false, "createdAt": 1783339818825, "updatedAt": 1783339818882, "clientRequestId": "a9716fab-8ac2-47fd-803e-44e2ca22b948" }, "clientRequestId": "a9716fab-8ac2-47fd-803e-44e2ca22b948" } } bindings: [] extensions: - id: x-parser-unique-object-id value: completeFillNotification - &ref_22 id: partialFillNotification contentType: application/json payload: - name: Order Filled — Partial Fill type: object properties: - name: resultType type: string description: Always `partialFillOrder`. required: true - name: market type: string description: Contract name required: true - name: data type: object required: true properties: - name: statusCode type: integer description: Always `200`. required: true - name: body type: string description: Status message required: true - name: order type: object description: >- Omitted entirely from some error responses; when present, all fields below are populated. required: true properties: - name: market type: string description: Contract name required: true - name: orderId type: string description: Unique order identifier required: true - name: orderType type: string description: Order side enumValues: - buy - sell required: true - name: tradeType type: string description: Order type enumValues: - limit - market required: true - name: price type: string description: Order price required: true - name: quantity type: string description: Order quantity required: true - name: filledQuantity type: string description: Quantity filled so far required: true - name: leverage type: string description: Leverage — always `0` for options required: true - name: orderStatus type: string description: > `pending` awaiting acceptance; `open` resting on the book; `cancelled` cancelled; `filled` completely filled; `rejected` rejected enumValues: - pending - open - cancelled - filled - rejected required: true - name: postOnly type: boolean description: Maker-only flag required: true - name: createdAt type: integer description: Creation time (ms since epoch) required: true - name: updatedAt type: integer description: Last update time (ms since epoch) required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `partialFillOrder`. x-parser-schema-id: market: type: string description: Contract name x-parser-schema-id: data: type: object properties: statusCode: type: integer description: Always `200`. x-parser-schema-id: body: type: string description: Status message x-parser-schema-id: order: *ref_0 clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - statusCode - body - order x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Order Filled — Partial Fill example: |- { "resultType": "partialFillOrder", "market": "BTC-10JUL26-55000-C", "data": { "statusCode": 200, "body": "order partially filled", "order": { "market": "BTC-10JUL26-55000-C", "orderId": "01KWVN9WSB5H7ZQK2P3M4NR8XA", "orderType": "buy", "tradeType": "limit", "price": "7000", "quantity": "2", "filledQuantity": "1", "leverage": "0", "orderStatus": "open", "postOnly": false, "createdAt": 1783339700000, "updatedAt": 1783339750000, "clientRequestId": "3d1f9c02-5a77-4c1e-9b6a-2e8d4f0b1c33" }, "clientRequestId": "3d1f9c02-5a77-4c1e-9b6a-2e8d4f0b1c33" } } bindings: [] extensions: - id: x-parser-unique-object-id value: partialFillNotification bindings: [] extensions: *ref_1 sendOperations: - *ref_3 - *ref_4 - *ref_5 receiveOperations: - *ref_6 - *ref_7 - *ref_8 - *ref_9 sendMessages: - *ref_10 - *ref_11 - *ref_12 receiveMessages: - *ref_13 - *ref_14 - *ref_15 - *ref_16 - *ref_17 - *ref_18 - *ref_19 - *ref_20 - *ref_21 - *ref_22 extensions: - id: x-parser-unique-object-id value: orderCreationStream securitySchemes: - id: wsAuth name: Sec-WebSocket-Protocol type: httpApiKey description: Supply as `authorization#` during the WebSocket handshake. in: header extensions: [] ````