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.

Table 1. setClient
ParameterRequired Description
CommandYsetClient
ClientYCustomer or Service Bureau’s Cboe Firm ID
allowIsoN0=restrict, 1=allow
allowDirectedIsoN0=restrict, 1=allow
blockNewOrdersN0=do not block, 1=block
cancelOpenOrdersN0=do not cancel, 1=cancel
cancelDayOrdersN0=do not cancel, 1=cancel
maxNotionalValueN0=use default max notional
maxContractSizeN0=use default max size
executionCollarPreMkt1NPre-Market Fat Finger % Tier 1 (< $2)**
executionCollarPreMkt2NPre-Market Fat Finger % Tier 2 (>= $2 and <= $5)**
executionCollarPreMkt3NPre-Market Fat Finger % Tier 3 (>= $5.01 and < =$10)**
executionCollarPreMkt4NPre-Market Fat Finger % Tier 4 (>= $10.01 and <= $20)**
executionCollarPreMkt5NPre-Market Fat Finger % Tier 5 (>= $20.01 and <= $50)**
executionCollarPreMkt6N
  • Pre-Market Fat Finger % Tier 6
  • (>= $50.01 and <= $100)**
executionCollarPreMkt7NPre-Market Fat Finger % Tier 7 (>=$100.01)**
executionCollarRegMkt1NRegular Session Fat Finger % Tier 1 (< $2)**
executionCollarRegMkt2NRegular Session Fat Finger % Tier 2 (>= $2 and <= $5)**
executionCollarRegMkt3N
  • Regular Session Fat Finger % Tier 3
  • (>= $5.01 and < =$10)**
executionCollarRegMkt4N
  • Regular Session Fat Finger % Tier 4
  • (>= $10.01 and <= $20)**
executionCollarRegMkt5N
  • Regular Session Fat Finger % Tier 5
  • (>= $20.01 and <= $50)**
executionCollarRegMkt6N
  • Regular Session Fat Finger % Tier 6
  • (>= $50.01 and <= $100)**
executionCollarRegMkt7NRegular Session Fat Finger % Tier 7 (>=$100.01)**
executionCollarDollarPreMkt1NPre-Market Fat Finger Dollar Tier 1 (< $2)**
executionCollarDollarPreMkt2NPre-Market Fat Finger Dollar Tier 2 (>= 2 and <= $5)**
executionCollarDollarPreMkt3N
  • Pre-Market Fat Finger Dollar Tier 3
  • (>= $5.01 and <= $10)**
executionCollarDollarPreMkt4N
  • Pre-Market Fat Finger Dollar Tier 4
  • (>= $10.01 and <= $20)**
executionCollarDollarPreMkt5NFat Finger Dollar Tier 5 (>= $20.01 and < $50)**
executionCollarDollarPreMkt6N
  • Pre-Market Fat Finger Dollar Tier 6
  • (>=$50.01 and >=$100)
executionCollarDollarRegMkt1NRegular Session Fat Finger % Tier 1 (< $2)**
executionCollarDollarRegMkt2NRegular Session Fat Finger % Tier 2 (>= $2 and <= $5)**
executionCollarDollarRegMkt3N
  • Regular Session Fat Finger % Tier 3
  • (>= $5.01 and < =$10)**
executionCollarDollarRegMkt4N
  • Regular Session Fat Finger % Tier 4
  • (>= $10.01 and <= $20)**
executionCollarDollarRegMkt5N
  • Regular Session Fat Finger % Tier 5
  • (>= $20.01 and <= $50)**
executionCollarDollarRegMkt6N
  • Regular Session Fat Finger % Tier 6
  • (>= $50.01 and <= $100)**
  • exceptionClass1ExecutionCollarPreMkt1
  • (C1 Only)
NPre-Market Fat Finger % Tier 1 (< $2)**
  • exceptionClass1ExecutionCollarPreMkt2
  • (C1 Only)
NPre-Market Fat Finger % Tier 2 (>= $2 and <= $5)**
  • exceptionClass1ExecutionCollarPreMkt3
  • (C1 Only)*
NPre-Market Fat Finger % Tier 3 (>= $5.01 and < =$10)**
  • exceptionClass1ExecutionCollarPreMkt4
  • (C1 Only)
NPre-Market Fat Finger % Tier 4 (>= $10.01 and <= $20)**
  • exceptionClass1ExecutionCollarPreMkt5
  • (C1 Only)
NPre-Market Fat Finger % Tier 5 (>= $20.01 and <= $50)**
  • exceptionClass1ExecutionPreMkt6
  • (C1 Only)
N
  • Pre-Market Fat Finger % Tier 6
  • (>= $50.01 and <= $100)**
  • exceptionClass1ExecutionCollarPreMkt7
  • (C1 Only)
NPre-Market Fat Finger % Tier 7 (>=$100.01)**
  • exceptionClass1ExecutionCollarRegMkt1
  • (C1 Only)
NRegular Session Fat Finger % Tier 1 (< $2)**
  • exceptionClass1ExecutionCollarRegMkt2
  • (C1 Only)
NRegular Session Fat Finger % Tier 2 (>= $2 and <= $5)**
  • exceptionClass1ExecutionCollarRegMkt3
  • (C1 Only)
N
  • Regular Session Fat Finger % Tier 3
  • (>= $5.01 and < =$10)**
  • exceptionClass1ExecutionCollarRegMkt4
  • (C1 Only)
N
  • Regular Session Fat Finger % Tier 4
  • (>= $10.01 and <= $20)**
  • exceptionClass1ExecutionCollarRegMkt5
  • (C1 Only)
N
  • Regular Session Fat Finger % Tier 5
  • (>= $20.01 and <= $50)**
  • exceptionClass1ExecutionCollarRegMkt6
  • (C1 Only)
N
  • Regular Session Fat Finger % Tier 6
  • (>= $50.01 and <= $100)**
  • exceptionClass1ExecutionCollarRegMkt7
  • (C1 Only)
NRegular Session Fat Finger % Tier 7 (>=$100.01)**
exceptionClass1ExecutionCollarDollarPreMkt1 (C1 Only)NPre-Market Fat Finger Dollar Tier 1 (< $2)**
exceptionClass1ExecutionCollarDollarPreMkt2 (C1 Only)NPre-Market Fat Finger Dollar Tier 2 (>= 2 and <= $5)**
exceptionClass1ExecutionCollarDollarPreMkt3 (C1 Only)N
  • Pre-Market Fat Finger Dollar Tier 3
  • (>= $5.01 and <= $10)**
exceptionClass1ExecutionCollarDollarPreMkt4 (C1 Only)N
  • Pre-Market Fat Finger Dollar Tier 4
  • (>= $10.01 and <= $20)**
exceptionClass1ExecutionCollarDollarPreMkt5 (C1 Only)NFat Finger Dollar Tier 5 (>= $20.01 and < $50)**
exceptionClass1ExecutionCollarDollarPreMkt6 (C1 Only)N
  • Pre-Market Fat Finger Dollar Tier 6
  • (>=$50.01 and >=$100)
exceptionClass1ExecutionCollarDollarRegMkt1 (C1 Only)NRegular Session Fat Finger % Tier 1 (< $2)**
exceptionClass1ExecutionCollarDollarRegMkt2 (C1 Only)NRegular Session Fat Finger % Tier 2 (>= $2 and <= $5)**
exceptionClass1ExecutionCollarDollarRegMkt3 (C1 Only)N
  • Regular Session Fat Finger % Tier 3
  • (>= $5.01 and < =$10)**
exceptionClass1ExecutionCollarDollarRegMkt4 (C1 Only)N
  • Regular Session Fat Finger % Tier 4
  • (>= $10.01 and <= $20)**
exceptionClass1ExecutionCollarDollarRegMkt5 (C1 Only)N
  • Regular Session Fat Finger % Tier 5
  • (>= $20.01 and <= $50)**
exceptionClass1ExecutionCollarDollarRegMkt6 (C1 Only)N
  • Regular Session Fat Finger % Tier 6
  • (>= $50.01 and <= $100)**
dupOrderActionN
  • Action When Duplicative Orders are Encountered:
  • O=Off (no action), R=Reject Orders, D=Disable Port
  • Note the key for duplicative order checks are:
  • Clearing EFID, Symbol, Price, Size and Side (i.e. Buy or not)
dupOrderCountNOrder Count Threshold
dupOrderSecondsNTime Threshold in seconds
ClearingNThe 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":""}
Cboe Titanium U.S. Secure Web API - setClient | Cboe