setClient
Use this command to cancel open orders/quotes or to initiate a kill switch (cancel+block). The allowed combinations of blockNewOrders and cancelOpenOrders are described in the table below. All other combinations will result in no action (no orders/quotes cancelled and no orders/quotes blocked). The operatorId field must be populated with the Order Entry Operator ID in order to cancel open orders/quotes or to initiate a kill switch.
A block of new orders/quotes will not persist across trading segments/dates. To reverse blockNewOrders= 1 within the same trading day, a clearing firm must call the CFE Trade Desk. A trading firm may either call the CFE Trade Desk or send the appropriate risk reset message using BOE/FIX. Unblocking new orders/quotes within the same trading segment/date will not be available via the API.
| blockNewOrders | cancelOpenOrders | Result |
|---|---|---|
| Not sent | 1 | Open orders/quotes for EFID are cancelled. |
| 0 | 1 | Open orders/quotes for EFID are cancelled. |
| 1 | 1 |
|
| 1 | 0 | No action taken. |
| 1 | Not Sent | No action taken. |
| Parameter | Required | Description |
|---|---|---|
| Command | Y | setClient |
| product_type | Y |
|
| Clearing | Y | Four character EFID |
| blockNewOrders | N | 1 = block |
| cancelOpenOrders | Y | 1 = cancel |
| operatorId | Y | Identifies the Order Entry Operator responsible for the setClient request. Must be at least 3 characters and no more than 18. Characters in the ASCII range 33-126 are allowed, except for comma, semicolon, and pipe. |
| manualOrderInd | Y |
|
* Note that at least one of the optional parameters must be specified. You may supply one or multiple optional parameters in a single request.
Example Response
{"code":"200", "msg":""}