| 1.0.0 | 12/14/09 | Release 1.0.0 distributed. |
| 1.0.1 | 04/15/10 | Noted support only for BZX Exchange at this time. |
| 1.1.0 | 04/05/11 | Added support for BYX Exchange. |
| 1.2.0 | 07/09/12 | - Added Options US Services section.
- Added Market Maker Registration Services (Equities and Options).
- Added Risk Management Services (Options).
|
| 1.3.0 | 10/12/12 | - Added Port Controls Services (Equities and Options).
- Noted Sponsored Access Service is now considered deprecated in favor of the new Port Controls Service.
- Added executionCollar, dailyLimitCutoff, dailyLimitNetCutoff, dailyMktCutoff, and dailyMktNetCutoff parameters to setClient command
|
| 1.3.1 | 11/01/12 | Field order correction in uploadRules definition for Risk Management Services (Options). |
| 1.3.2 | 12/28/12 | Correction to command description in ClearAllSeries command. |
| 1.3.3 | 03/28/13 | - Added parameter to exclude Mini Options symbols from Options Market Maker Registration storeSeriesList command.
- Added confirmation of Max Quote value in Equities Market Maker Registration viewRegisteredSymbols command.
|
| 1.3.4 | 05/10/13 | Minor clarifications and corrections made to Options storeSeriesList and viewSeriesStatus commands. |
| 1.3.5 | 10/3/13 | Added parameter to exclude Jumbo Options symbols from Options Market Maker Registration storeSeriesList command. |
| 1.3.6 | 12/03/13 | Added viewActiveRegisteredSymbols command and removed references to Max Quote in Equities Market Maker Registration section. |
| 1.3.7 | 10/20/14 | Added the new EDGX and EDGA service links for API functionality. Available effective 01/12/15. |
| 1.3.8 | 01/12/15 | Updated uploadRegisteredSymbols example response. |
| 1.3.9 | 02/06/15 | - Updated setClient command for Equities and Options Port Controls and Sponsored Access sections to reflect changes to Fat Finger Protection.
- Removed references to 1/12/15 effective date.
|
| 1.3.10 | 02/20/15 | Updated setClient command for Equities and Options Port Controls and Sponsored Access sections to reflect addition of duplicative order controls added effective 2/20/15. |
| 1.3.11 | 03/16/15 | Added viewClients command for Equities and Options Port Controls sections. Available effective 3/27/15. |
| 1.3.12 | 03/23/15 | Corrected broken links to deprecated US Equities/Options Sponsored Access Specification. |
| 1.4.0 | 04/02/15 | Added Ports Information Service with viewPortConnections and viewPortAttributes commands. Available effective 4/6/15. |
| 1.4.1 | 04/08/15 | - Corrected URL in Options Ports Information Service section (5.5).
- Corrected example response for Options viewPortAttributes section (5.5.2).
|
| 1.4.2 | 04/21/15 | Update name change for Bats Options Exchange to BZX Options Exchange. |
| 1.4.3 | 07/27/15 | Included support for EDGX Options Exchange |
| 1.5.0 | 08/06/15 | - Removed references to deprecated Sponsored Access service.
- Added Single Order ADV Check section.
|
| 1.6.0 | 09/08/15 | Added symbol data and book data services. |
| 1.7.0 | 02/19/16 | Bats branding/logo changes. |
| 1.7.1 | 05/06/16 | Added Warning Percentage Features for Aggregated Credit Limit Risk Checks |
| 1.7.2 | 05/18/16 | Added support for Liquidity Management Provider registration. |
| 1.8.0 | 05/01/17 | Added support for CFE. |
| 1.8.1 | 05/22/17 | Removed references to deprecated call_put_flag and front_trail_flag fields from Options Risk Management Service section (5.3). |
| 1.8.2 | 09/01/17 | Added support for C2’s transition onto the Bats Technology platform. |
| 1.9.0 | 09/06/17 | Added EDGX/BZX Top-of-Book API |
| 1.9.1 | 10/17/17 | Cboe branding/logo changes. |
| 1.9.2 | 05/23/18 | Changed osi_root value to risk_root. |
| 1.10.0 | 11/16/18 | - Added Clearing Edit Service Support.
- Added support for Cboe Options Exchange.
|
| 1.10.1 | 11/27/18 | Added detail that the Clearing Edit Service will be available in Feature Pack 3, in preparation for C1 Migration. |
| 1.10.2 | 01/22/19 | - Added certification environment URLs.
- Corrected typos in Clearing Edit Service addToQueue examples.
|
| 1.10.3 | 01/29/19 | Additional clarification on required items for the addToQueue command. |
| 1.10.4 | 04/17/19 | Updates to Market Maker Registration service to reflect that registration by symbology will be sunset (effective 05/10/19). |
| 1.10.5 | 05/02/19 | - Added support for risk_group_type within Risk Management Service for Options (effective on C2 and EDGX with C1 Feature Pack 7).
- Updated Market Maker Registration service to reflect that registration by symbol will remain active for BZX and only be sunset for EDGX (effective 05/10/19).
|
| 1.10.6 | 05/10/19 | - Clarified description of
clearRules identifier parameter. - Added uploadRules Application in Trading Session table.
- Clarfied valid values for Symbology parameter in
storeSeriesList.
|
| 1.10.7 | 05/17/19 | - Added ‘allowDirectedIso’, ‘portThreshold’ and ‘symbolThreshold’ parameters to
setClient command for US Equities. - Added ‘allowDirectedIso’ paramteter to
setClient command for US Options. - Added Fat Finger Protection parmeters to
setClient command for US Options.
|
| 1.10.8 | 07/15/19 | Fixed incorrect section numbering in Section 5 of the document. |
| 1.10.9 | 09/25/19 | - Added Clearing Edit Service field support for C1-specific parameters.
- Added notes indicating BZX will only support a symbology parameter value of ‘underlying’ in
storeSeriesList command when registration by series is sunset. , effective 10/1/19. The following storeSeriesList parameters will be sunset effective 10/1/19: exclude_sdo, exclude_close_only, expire_period, auto_reg_underlying.
|
| 1.10.10 | 10/02/19 | - Reworked the viewTrades section fo the Clearing Edit service to more accurately describe the filters available when running the viewTrades command.
- Added a translation table to allow users to translate from the values received when using viewTrades and the values that are expected to be sent when using addToQueue.
|
| 1.10.11 | 11/08/19 | Removed symbology parameter from storeSeriesList commands as this is no longer necessary following Market Maker appointment by class updates. |
| 1.10.12 | 11/12/19 | Added notes indicating GTH will be deprecated on EDGX and C2, effective 11/22/19. |
| 1.10.13 | 01/08/20 | Fixed section numbering for uploadRegisteredSymbols command. Added note to indicate that editing the capacity parameter with a value of ‘C’, in the ViewTrades command to any other value must be made via the Clearing Editor (effective 02/07/20). |
| 1.10.14 | 02/07/20 | Removed effective date notes for features released to production. |
| 1.10.15 | 04/15/20 | - Added reason_code and reason_text fields to the list of parameters for the US Options Clearing Edit Service.
- Added US Equities Risk Management Service section.
|
| 1.10.16 | 04/27/2020 | - Added support for Risk Group ID.
- Noted Notional Exposure Tracking to be deprecated on Options effective 5/8/20.
|
| 1.10.17 | 10/20/20 | Removed deprecated parameters from setClient command in Port Controls. |
| 1.10.18 | 03/25/21 | Added notes indicating GTH and Curb risk rule upload cutoff times in the "uploadRules Application in Trading Session" table (effective 04/25/22 TBD 02/07/22 TBD 09/27/21 Q3 2021 for Curb and 11/21/21 Q4 2021 for GTH). |
| 1.10.19 | 05/13/21 | - Updated section 4 entries in US Equities Services table to include Risk Manager and Top services.
- Updated Curb session effective date to 04/25/22 TBD 02/07/22 TBD 09/27/21.
|
| 1.10.20 | 05/20/21 | Added Port Controls Service to CFE (effective 07/11/21 06/13/21). |
| 1.10.21 | 06/11/21 | Clarification around kill switch functionality and updated effective date to 07/11/21. |
| 1.10.22 | 06/15/21 | Updated extended GTH session effective date to 11/21/21. |
| 1.10.23 | 06/30/21 | Updated Futures Services setClient command table with new entry detailing combination of 1 blockNewOrders and cancelOpenOrders not sent. |
| 1.10.24 | 07/26/21 | Updated uploadRules Application in Trading Session table. |
| 1.10.25 | 08/24/21 | Updated Curb session effective date to 04/25/22 TBD 02/07/22 TBD. |
| 1.10.26 | 09/09/21 | Added new sections "viewHard", "uploadHard", and "removeHard" to support the Hard to Borrow list functionality (effective 01/26/22 TBD 09/29/21). |
| 1.10.27 | 10/04/21 | - Updated the Cboe Web Portal Port Controls Specification link.
- Updated effective dates for "viewHard", "uploadHard", and "removeHard" commands to 01/26/22 TBD.
|
| 1.10.28 | 10/18/21 | Added requirement to CFE setClient service that the operatorId field must be populated with the Order Entry Operator ID in order to cancel open orders/quotes or to initiate a kill switch (effective 11/14/21). |
| 1.10.29 | 11/4/21 | Updated Curb session effective date to 04/25/22 TBD 02/07/22. |
| 1.10.30 | 11/15/21 | Added Block/ECRP service to US Futures section (effective 01/09/22). |
| 1.10.31 | 12/06/21 | Added country_alpha2_code to the list of parameters for submitTrade (effective 02/27/22). |
| 1.10.32 | 01/14/22 | Updated Hard-to-Borrow List effective date to 01/26/22. |
| 1.10.33 | 02/01/22 | Updated Curb session effective date to 04/25/22 TBD. |
| 1.10.34 | 03/21/22 | Added a note indicating Block and ECRP trades that include a country code for a comprehensively sanctioned country on either side of the trade will be rejected. |
| 1.10.35 | 04/04/22 | Updated Curb session effective date to 04/25/22. |
| 1.11.0 | 07/29/22 | Added support for CFE Options on Futures (effective 07/10/23 04/03/23). |
| 1.11.1 | 08/19/22 | Added allowShortSales, allowShortSaleExempt, requireLocateBrokerOnShortSaleOrders, and requireLocateBrokerOnShortSaleExemptOrders parameters to the US Equities Port Controls service (effective 10/14/22). |
| 1.11.2 | 11/29/22 | Updated uploadRules and setClient sections for clarity. |
| 1.11.3 | 01/19/23 | Updated effective date for Options on Futures (effective 07/10/23). |
| 1.11.4 | 07/20/23 | Added new product_type field to getProducts (effective 08/21/23 07/30/23). |
| 1.11.5 | 08/01/23 | Updated effective date for product_type field (effective 08/21/23). |
| 1.11.6 | 09/13/23 | Added new marketOrderRestriction to setClient (effective 10/13/23). |
| 1.11.7 | 11/09/23 | Updated storeSeriesList example to include C1 and EDGX Options example response (effective 11/25/23). |
| 1.11.8 | 05/23/24 | - Removed references to IBHYT and IBIGT as part of CFE sunsetting TAS functionality for coproate bond index futures.
- Changing capacity from ‘C’ to another value may not be done using the API and can only be changed using the Clearing Editor.
- Added list of fields unable to be changed on floor trades using the API to section 5.5.3.
|
| 1.11.9 | 06/28/24 | Updated getInstrumentsForProduct example. |
| 1.11.10 | 09/20/24 | Added limit_type and reject_behavior values to US Equities Risk Management Service uploadRules (effective 01/27/25 on EDGA and effective 02/03/25 on BYX, BZX, and EDGX 11/22/24). Updated US Equities Risk Management Service viewRules example response to include rej_only. |
| 1.11.11 | 10/30/24 | Updated example response for Book Data. |
| 1.11.12 | 11/18/24 | Updated the effective date for limit_type and reject_behavior values to US Equities Risk Management Service uploadRules to 01/27/25 on EDGA and effective 02/03/25 on BYX, BZX, and EDGX. |
| 1.11.13 | 01/15/25 | Updated with Cboe Titanium branding. |
| 1.11.14 | 08/22/25 | |
| 1.11.15 | 09/11/25 | Updated viewTrades to include new strategy_id values F = CompressionForum, B = BoxSpread, and A = BoxSwap. (C1 Only) |
| 1.11.16 | 11/18/25 | Updated table formatting to include a Required column throughout the specification. |
| 1.11.17 | 11/25/25 | |
| 1.11.18 | 12/16/25 | - Removed "dailyLimitCutoff":"100000000", "dailyLimitNetCutoff":"100000000", "dailyMktCutoff":"100000000", and "dailyMktNetCutoff":"100000000" from viewClient example (01/30/26).
- Updated dailyLimitCutoff, dailyLimitNetCutoff, dailyMktCutoff, and dailyMktNetCutoff Required setClient fields to note that as of 01/30/26 these fields will not be applicable and will be ignored.
|
| 1.11.19 | 01/16/26 | Added requireLocateBrokerShortToShort to setClient (effective 02/02/26). |
| 1.11.20 | 03/13/26 | Added viewControls and uploadControls messages to US Options Risk Management Service (effective 04/20/26). |
| 1.11.21 | 03/19/26 | Updated URLs: effective 08/31/26, Cboe will begin redirecting batstrading URLs. |
| 1.11.22 | 03/23/26 | - Updated viewControls Example Response to include "capacityFractions": "C:0.20,U:0.50".
- Updated uploadControls Example Response to include "capacityFractions": "C:0.30,U:0.60".
|
| 1.11.23 | 04/17/26 | Added Quoting Incentive Program Registration (effective 05/01/26) |
| 1.11.24 | 07/06/26 | - Updated U.S. Equities setClient table to indicate the executionCollarDollar2, executionCollarDollar3, executionCollarDollar4, executionCollarDollar5, dupOrderAction, dupOrderCount, dupOrderSeconds, and marketOrderRestriction parameters are not required.
- Removed U.S. Equities setClient parameters that are no longer applicable.
- Updated tradingDay description in viewRules for U.S. Equities, U.S. Options, and U.S. Futures.
|
| 1.11.25 | 08/04/26 | - Added new submitToClearingsection (effective as early as Q3, 2026).
- Added clearing_corp parameter to viewTrades to indicate valid values included OCC or CCUS (if field not specified, the value defaults to OCC).
- Updated submitToOcc to indicate that submitToOcc submits OCC-cleared trade edits to the OCC for reclearing and submits CCUS-cleared trade edits to CCUS for reclearing. The submitToClearing method should be used going forward as the submitToOcc method will be deprecated in the future.
- Updated to introduce new clearinghouse (OCC and CCUS) and CCUS ID top-level trade filters.
- Updated references to OCC to indicate clearinghouse as changes are submitted to clearinghouse associated with the underlying trade product.
|
