Trade orders

## Trading Workflow Documentation

This section outlines the trading workflow for creating an order and monitoring its fill status using Checker's Orchestration Platform API. The steps involved include creating an order and monitoring its status.

Step 1: Client Creates an Order

To create an order, the client sends a POST request to the /api/v1/orders endpoint with the following fields:

Request Body Example

{
  "instrumentPair": "BTC-USD",
  "quantity": 2.0,
  "side": "BUY",
  "price": 50000.00,
  "clientId": "client123",
  "date": "2024-05-28T14:30:00Z",
  "provider": "LP1",
  "clientOrderId": "order123",
  "requestForQuoteId": "12345",
  “tags”: [“strategy1”]
}

Field Descriptions

• instrumentPair: The trading pair for the order (e.g., "BTC-USD").
• quantity: The quantity to be traded for the given instrument pair.
• side: The side of the order (either "BUY" or "SELL").
• price: The price for the given instrument pair.
• clientId: The ID of the client placing the order.
• date: The date and time when the order is placed.
• provider: The liquidity provider handling the order.
• clientOrderId: The unique ID of the client order (generally provided by the client).
• requestForQuoteId: The ID of the associated RFQ, if applicable.
• Tags: For client use, inclusion of any number of tags.

Step 2: Client Monitors the Order Status

The client monitors the status and fill details of the order by sending a GET request to the /api/v1/orders/{orderId} endpoint.

Response Example

{
  "orderId": "order123",
  "instrumentPair": "BTC-USD",
  "quantity": 2.0,
  "side": "BUY",
  "status": "PARTIALLY_FILLED",
  "price": 50000.00,
  "clientId": "client123",
  "date": "2024-05-28T14:30:00Z",
  "provider": "LP1",
  "clientOrderId": "order123",
  "requestForQuoteId": "12345",
  "fills": [
     {
       "fillId": "fill1",
       "quantity": 1.0,
       "price": 50000.00,
       "date": "2024-05-28T14:35:00Z"
     },
     {
       "fillId": "fill2",
       "quantity": 1.0,
       "price": 50000.00,
       "date": "2024-05-28T14:40:00Z"
     }
   ]
}

Field Descriptions

• orderId: The unique ID of the order.
• instrumentPair: The trading pair for the order.
• quantity: The total quantity to be traded for the given instrument pair.
• side: The side of the order (either "BUY" or "SELL").
• status: The current status of the order (e.g., "NEW", "PARTIALLY_FILLED", "FILLED").
• price: The price for the given instrument pair.
• clientId: The ID of the client placing the order.
• date: The date and time when the order was placed.
• provider: The liquidity provider handling the order.
• clientOrderId: The unique ID of the client order.
• requestForQuoteId: The ID of the associated RFQ, if applicable.
• fills: A list of fill details for the order.
  • fillId: The unique ID of the fill.
  • quantity: The quantity filled in this transaction.
  • price: The price at which the quantity was filled.
  • date: The date and time when the fill occurred.

This trading workflow ensures that the client can create an order and monitor its status, including detailed fill information, through the Checker's Orchestration Platform API.