setClient
Use this command to update settings for all of your firm’s ports. Customers and Service Bureaus must specify their four character Cboe Firm ID.
| Parameter | Required | Description |
|---|---|---|
| Command | Y | setClient |
| Client | Y | Customer or Service Bureau’s Cboe Firm ID |
| allowIso | N | 0=restrict, 1=allow |
| allowDirectedIso | N | 0=restrict, 1=allow |
| blockNewOrders | N | 0=do not block, 1=block |
| cancelOpenOrders | N | 0=do not cancel, 1=cancel |
| cancelDayOrders | N | 0=do not cancel, 1=cancel |
| maxNotionalValue | N | 0=use default max notional |
| maxContractSize | N | 0=use default max size |
| executionCollarPreMkt1 | N | Pre-Market Fat Finger % Tier 1 (< $2)** |
| executionCollarPreMkt2 | N | Pre-Market Fat Finger % Tier 2 (>= $2 and <= $5)** |
| executionCollarPreMkt3 | N | Pre-Market Fat Finger % Tier 3 (>= $5.01 and < =$10)** |
| executionCollarPreMkt4 | N | Pre-Market Fat Finger % Tier 4 (>= $10.01 and <= $20)** |
| executionCollarPreMkt5 | N | Pre-Market Fat Finger % Tier 5 (>= $20.01 and <= $50)** |
| executionCollarPreMkt6 | N |
|
| executionCollarPreMkt7 | N | Pre-Market Fat Finger % Tier 7 (>=$100.01)** |
| executionCollarRegMkt1 | N | Regular Session Fat Finger % Tier 1 (< $2)** |
| executionCollarRegMkt2 | N | Regular Session Fat Finger % Tier 2 (>= $2 and <= $5)** |
| executionCollarRegMkt3 | N |
|
| executionCollarRegMkt4 | N |
|
| executionCollarRegMkt5 | N |
|
| executionCollarRegMkt6 | N |
|
| executionCollarRegMkt7 | N | Regular Session Fat Finger % Tier 7 (>=$100.01)** |
| executionCollarDollarPreMkt1 | N | Pre-Market Fat Finger Dollar Tier 1 (< $2)** |
| executionCollarDollarPreMkt2 | N | Pre-Market Fat Finger Dollar Tier 2 (>= 2 and <= $5)** |
| executionCollarDollarPreMkt3 | N |
|
| executionCollarDollarPreMkt4 | N |
|
| executionCollarDollarPreMkt5 | N | Fat Finger Dollar Tier 5 (>= $20.01 and < $50)** |
| executionCollarDollarPreMkt6 | N |
|
| executionCollarDollarRegMkt1 | N | Regular Session Fat Finger % Tier 1 (< $2)** |
| executionCollarDollarRegMkt2 | N | Regular Session Fat Finger % Tier 2 (>= $2 and <= $5)** |
| executionCollarDollarRegMkt3 | N |
|
| executionCollarDollarRegMkt4 | N |
|
| executionCollarDollarRegMkt5 | N |
|
| executionCollarDollarRegMkt6 | N |
|
| N | Pre-Market Fat Finger % Tier 1 (< $2)** |
| N | Pre-Market Fat Finger % Tier 2 (>= $2 and <= $5)** |
| N | Pre-Market Fat Finger % Tier 3 (>= $5.01 and < =$10)** |
| N | Pre-Market Fat Finger % Tier 4 (>= $10.01 and <= $20)** |
| N | Pre-Market Fat Finger % Tier 5 (>= $20.01 and <= $50)** |
| N |
|
| N | Pre-Market Fat Finger % Tier 7 (>=$100.01)** |
| N | Regular Session Fat Finger % Tier 1 (< $2)** |
| N | Regular Session Fat Finger % Tier 2 (>= $2 and <= $5)** |
| N |
|
| N |
|
| N |
|
| N |
|
| N | Regular Session Fat Finger % Tier 7 (>=$100.01)** |
| exceptionClass1ExecutionCollarDollarPreMkt1 (C1 Only) | N | Pre-Market Fat Finger Dollar Tier 1 (< $2)** |
| exceptionClass1ExecutionCollarDollarPreMkt2 (C1 Only) | N | Pre-Market Fat Finger Dollar Tier 2 (>= 2 and <= $5)** |
| exceptionClass1ExecutionCollarDollarPreMkt3 (C1 Only) | N |
|
| exceptionClass1ExecutionCollarDollarPreMkt4 (C1 Only) | N |
|
| exceptionClass1ExecutionCollarDollarPreMkt5 (C1 Only) | N | Fat Finger Dollar Tier 5 (>= $20.01 and < $50)** |
| exceptionClass1ExecutionCollarDollarPreMkt6 (C1 Only) | N |
|
| exceptionClass1ExecutionCollarDollarRegMkt1 (C1 Only) | N | Regular Session Fat Finger % Tier 1 (< $2)** |
| exceptionClass1ExecutionCollarDollarRegMkt2 (C1 Only) | N | Regular Session Fat Finger % Tier 2 (>= $2 and <= $5)** |
| exceptionClass1ExecutionCollarDollarRegMkt3 (C1 Only) | N |
|
| exceptionClass1ExecutionCollarDollarRegMkt4 (C1 Only) | N |
|
| exceptionClass1ExecutionCollarDollarRegMkt5 (C1 Only) | N |
|
| exceptionClass1ExecutionCollarDollarRegMkt6 (C1 Only) | N |
|
| dupOrderAction | N |
|
| dupOrderCount | N | Order Count Threshold |
| dupOrderSeconds | N | Time Threshold in seconds |
| Clearing | N | The EFID used in the relationship (required when multiple EFIDs are in use) |
* Note that at least one of the optional parameters must be specified. You may supply one or multiple optional parameters in a single request.
** Refer to the Cboe Titanium U.S. Equities/Options Web Portal Port Controls Specification for more information on this parameter.
Example Response
{"code":"200", "msg":""}




