setClient

Use this command to update default settings for all of your firm’s ports. Customers and Service Bureaus must specify their four character Cboe Firm ID.

Table 1. setClient
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
allowShortSales	N	0=restrict, 1=allow
allowShortSaleExempt	N	0=restrict, 1=allow
requireLocateBrokerOnShortSaleOrders	N	0=no, 1=yes
requireLocateBrokerOnShortSaleExemptOrders	N	0=no, 1=yes
requireLocateBrokerShortToShort	N	0=no, 1=yes
allowPremarket	N	0=restrict, 1=allow
allowPostMarket	N	0=restrict, 1=allow
blockNewOrders	N	0=do not block, 1=block
cancelOpenOrders	N	0=do not cancel, 1=cancel
advPercent	N	Percent of ADV for Single Order ADV Checks. An integer from 1 to 100.
advMinThreshold	N	Enable when ADV Exceeds (shares), i.e. the Minimum Threshold for Single Order ADV Checks. An integer greater than 0.
maxNotionalValue	N	0=use default max notional
maxShareSize	N	0=use default max size
portThreshold	N	An integer from 1 to 5000.
symbolThreshold	N	An integer from 1 to 5000.
executionCollar1	N	Fat Finger % Tier 1 (< $1)** An integer from 1 to 75.
executionCollar2	N	Fat Finger % Tier 2 (>= $1 and < $10)** An integer from 1 to 50.
executionCollar3	N	Fat Finger % Tier 3 (>= $10 and < $50)** An integer from 1 to 20.
executionCollar4	N	Fat Finger % Tier 4 (>= $50 and < $100)** An integer from 1 to 20.
executionCollar5	N	Fat Finger % Tier 5 (>= $100 and < $500)** An integer from 1 to 20.
executionCollar6	N	Fat Finger % Tier 6 (>= $500)** An integer from 1 to 20.
executionCollarDollar1	N	Fat Finger Dollar Tier 1 (< $1)**
executionCollarDollar2	N	Fat Finger Dollar Tier 2 (>= $1 and < $10)**
executionCollarDollar3	N	Fat Finger Dollar Tier 3 (>= $10 and < $50)**
executionCollarDollar4	N	Fat Finger Dollar Tier 4 (>= $50 and < $100)**
executionCollarDollar5	N	Fat Finger Dollar Tier 5 (>= $100 and < $500)**
rejectMktNoNbbo	Y	0=do not reject, 1=reject
dupOrderAction	N	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 MPID, Symbol, Price, Size and Side (i.e. Buy or not)
dupOrderCount	N	Order Count Threshold
dupOrderSeconds	N	Time Threshold in seconds
clearing	Y	The MPID used in the relationship (required when multiple MPIDs are in use)
marketOrderRestriction	N	1=Allow MKT orders, 2=Reject MKT orders during continuous trading and allow during auctions, 3=Reject MKT orders during continuous trading and also during auctions

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":""}

New to Options?

Next Level Learning for More Advanced Investors

setClient