uploadRules

Upload a rule set for the next trading day.

Table 1. uploadRules
ParameterRequired Description
commandYuploadRules
identifierYExecuting Firm ID
rulesYComma-delimited list of rules to add

Rule Format:

Colon-separated list of values as follows:

        mpid:limit_type:symbol:limit_value:risk_group_id:reject_behavior
Table 2. uploadRules Parameters
ParameterRequired Description
mpidYSpecifies the MPID to which the risk setting applies. A valid MPID must be included and the firm must have control of the MPID.
limit_typeYThe limit type must be one of the following values:
  • abs_ntnl - Absolute Gross Notional

  • abs_nntnl - Absolute Net Notional

  • agg_gcdt - Aggregated Gross Credit

  • agg_ncdt - Aggregated Net Credit
symbolYNot supported. Must be blank.
limit_valueYThis value must be an integer value. Floating point values are not accepted. When the limit type is a notional type, this represents whole dollars.
risk_group_idNInteger 1-65535.
reject_behaviorN
  • rej_cncl (resting orders are cancelled and inbound orders are rejected) or

  • rej_only (resting orders are not cancelled and inbound orders are rejected)

  • If not specified, rej_cncl is default.

  • Please note that only one reject_behavior per limit_type is allowed.

Example Request

rules=CBOE:abs_ntnl::1000000000,CBGM:abs_nntnl::1000000:rej_only

Example Response

   {
     "msg":"Rules updated",
     "code":"200",
     "data":{
             "duplicateCount":0,
             "removeCount":2,
             "processedCount":2,
             "spacesCount":0,
             "efidsInUpload":[


 "CBOE",
 "CGBM",],             
 "unknownList":[],
 "addCount":2}
   }
Cboe Titanium U.S. Secure Web API - uploadRules | Cboe