Sign In

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
ParameterRequired Description
commandYsetClient
clientYCustomer or Service Bureau’s Cboe Firm ID
allowIsoN0=restrict, 1=allow
allowDirectedIsoN0=restrict, 1=allow
allowShortSalesN0=restrict, 1=allow
allowShortSaleExemptN0=restrict, 1=allow
requireLocateBrokerOnShortSaleOrdersN0=no, 1=yes
requireLocateBrokerOnShortSaleExemptOrdersN0=no, 1=yes
requireLocateBrokerShortToShort N0=no, 1=yes
allowPremarketN0=restrict, 1=allow
allowPostMarketN0=restrict, 1=allow
blockNewOrdersN0=do not block, 1=block
cancelOpenOrdersN0=do not cancel, 1=cancel
advPercentN
  • Percent of ADV for Single Order ADV Checks.
  • An integer from 1 to 100.
advMinThresholdN
  • Enable when ADV Exceeds (shares), i.e. the Minimum Threshold for Single Order ADV Checks.
  • An integer greater than 0.
maxNotionalValueN0=use default max notional
maxShareSizeN0=use default max size
portThresholdNAn integer from 1 to 5000.
symbolThresholdNAn integer from 1 to 5000.
executionCollar1N
  • For RTH session only.
  • Fat Finger % Tier 1 (< $1)**
  • An integer from 1 to 75.
executionCollar2N
  • For RTH session only.
  • Fat Finger % Tier 2 (>= $1 and < $10)**
  • An integer from 1 to 50.
executionCollar3N
  • For RTH session only.
  • Fat Finger % Tier 3 (>= $10 and < $50)**
  • An integer from 1 to 20.
executionCollar4N
  • For RTH session only.
  • Fat Finger % Tier 4 (>= $50 and < $100)**
  • An integer from 1 to 20.
executionCollar5N
  • For RTH session only.
  • Fat Finger % Tier 5 (>= $100 and < $500)**
  • An integer from 1 to 20.
executionCollar6N
  • For RTH session only.
  • Fat Finger % Tier 6 (>= $500)**
  • An integer from 1 to 20.
executionCollarDollar1N
  • For RTH session only.
  • Fat Finger Dollar Tier 1 (< $1)**
executionCollarDollar2N
  • For RTH session only.
  • Fat Finger Dollar Tier 2 (>= $1 and < $10)**
executionCollarDollar3N
  • For RTH session only.
  • Fat Finger Dollar Tier 3 (>= $10 and < $50)**
executionCollarDollar4N
  • For RTH session only.
  • Fat Finger Dollar Tier 4 (>= $50 and < $100)**
executionCollarDollar5N
  • For RTH session only.
  • Fat Finger Dollar Tier 5 (>= $100 and < $500)**
executionCollarNonRth1 (Effective 10/26/26) N
  • For non-RTH sessions.
  • Fat Finger % Tier 1 (< $1)**
  • An integer from 1 to 75.
executionCollarNonRth2 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger % Tier 2 (>= $1 and < $10)**
  • An integer from 1 to 50.
executionCollarNonRth3 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger % Tier 3 (>= $10 and < $50)**
  • An integer from 1 to 20.
executionCollarNonRth4 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger % Tier 4 (>= $50 and < $100)**
  • An integer from 1 to 20.
executionCollarNonRth5 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger % Tier 5 (>= $100 and < $500)**
  • An integer from 1 to 20.
executionCollarNonRth6 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger % Tier 6 (>= $500)**
  • An integer from 1 to 20.
executionCollarDollarNonRth1 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger Dollar Tier 1 (< $1)**
executionCollarDollarNonRth2 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger Dollar Tier 2 (>= $1 and < $10)**
executionCollarDollarNonRth3 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger Dollar Tier 3 (>= $10 and < $50)**
executionCollarDollarNonRth4 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger Dollar Tier 4 (>= $50 and < $100)**
executionCollarDollarNonRth5 (Effective 10/26/26)N
  • For non-RTH sessions.
  • Fat Finger Dollar Tier 5 (>= $100 and < $500)**
rejectMktNoNbboY0=do not reject, 1=reject
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 MPID, Symbol, Price, Size and Side (i.e. Buy or not)
dupOrderCountNOrder Count Threshold
dupOrderSecondsNTime Threshold in seconds
clearingYThe MPID used in the relationship (required when multiple MPIDs are in use)
marketOrderRestrictionN1=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
allowOvernight (EDGX only) (Effective 11/20/26) N0=restrict, 1=allow

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": "",
    "data": {
        "advMinThreshold": "",
        "advPercent": "",
        "allowDirectedIso": 1,
        "allowIso": 1,
        "allowPostMarket": 1,
        "allowPreMarket": 1,
        "allowShortSaleExempt": 1,
        "allowShortSales": 1,
        "blockNewOrders": 0,
        "dupOrderAction": "O",
        "dupOrderCount": "",
        "executionCollar1": 10,
        "executionCollar2": 5,
        "executionCollar3": 3,
        "executionCollar4": 2,
        "executionCollar5": 2,
        "executionCollar6": 1,
        "executionCollarNonRth1": 20,
        "executionCollarNonRth2": 10,
        "executionCollarNonRth3": 6,
        "executionCollarNonRth4": 4,
        "executionCollarNonRth5": 4,
        "executionCollarNonRth6": 2,
        "executionCollarDollar1": "0.25",
        "executionCollarDollar2": "0.5",
        "executionCollarDollar3": "1",
        "executionCollarDollar4": "2",
        "executionCollarDollar5": "5",
        "executionCollarDollarNonRth1": "0.5",
        "executionCollarDollarNonRth2": "1",
        "executionCollarDollarNonRth3": "2",
        "executionCollarDollarNonRth4": "4",
        "executionCollarDollarNonRth5": "10",
        "marketOrderRestriction": 1,
        "maxNotionalValue": "",
        "maxShareSize": "",
        "portThreshold": "",
        "rejectMktNoNbbo": 0,
        "requireLocateBrokerShortToShort": 0,
        "requireLocateBrokerOnShortSaleOrders": 0,
        "requireLocateBrokerOnShortSaleExemptOrders": 0,
        "symbolThreshold": "",
        "stockLists": {
            "easy": {"validCount": 0, "unknownCount": 0},
            "hard": {"validCount": 2, "unknownCount": 2},
            "restricted": {"validCount": 0, "unknownCount": 0}
        }
    }
}
PreviousNext