OX XML API OSI Change Specifications

 

 

 

 

 

 

 

 

 

 

 

 

 

optionsXpress, Inc.

XML API Change Specifications

Required To Support Impending

Option Symbology Initiative

 

 

 

 

 

 

 

 

 

by

Pavel Zeldin

Vice President of IT Development

pzeldin@optionsxpress.com

10/29/2009


Revision History

Version

Date

Change Summary

Changed by

1.0

11/02/2009

DRAFT completed

Pavel Zeldin

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


1.    Purpose.

 

The purpose of this document is to communicate our plan to support OSI-compliant symbols via XML API.  This will enable our XML API partners to coordinate any necessary changes, thus ensuring smooth migration to the new symbol format.

 

2.    Introduction.

 

As many of you are aware, a group of options industry professionals has created a plan to overhaul equity and index options symbology in an effort to decrease the number of errors in front-/middle-/back- office processes, reduce corporate action symbol conversions, and eliminate LEAP roll-over process.  The OCC has approved the plan, and the new symbology will be rolled out into production environments starting February 12th, 2010.

 

The latest documentation on the Options Symbology Initiative (OSI) is available here.

 

3.    OSI approved symbol format:

 

Symbol

Year

Month

Day

C/P

Explicit Strike

Strike Decimal

MSFT

10

04

16

C

00028

000

 

4.    Industry-wide Implementation Plan and Timeline.

 

4.1             February 12th, 2010 – Symbol Conversion.  All OPRA symbols to be migrated to the new symbology format, preserving the OPRA root of the symbol.

 

Ex. “MSQDC” will be converted to “MSQ  100416C00028000”.

 

4.2             March – May, 2010 – Symbol Consolidation.  All roots in the new symbols are replaced with corresponding underlying symbols.

 

Ex.  “MSQ  100416C00028000” will be converted to ‘MSFT  100416C00028000”.

 

5.    optionsXpress XML API Plan and Timeline.

 

5.1             January 8th, 2010 - all web services available via XML API will be forward-compatible.  OPRA symbol as well as post-conversion format of symbols will be supported as inputs.  The option root symbol may be padded to 6 characters using either “space” or “^” (carrot sign).  OPRA symbols are returned in results for all options.

 

Ex. “.MSQDC”, “MSQ   100416C00028000”, or “MSQ^^^100416C00028000” will be supported as input parameters.

 

5.2             February 12th, 2010 – all web services available via XML API will be forward-compatible.  Conversion symbol as well as consolidated symbol will be supported as input parameters.  The option root symbol may be padded to 6 characters using either “space” or “^” (carrot sign).  OPRA symbols are no longer supported.  Converted symbols are returned in all result sets, padded with “^” (carrot sign). 

 

Ex. “MSQ   100416C00028000”, “MSQ^^^100416C00028000”, “MSFT  100416C00028000”, and “MSFT^^100416C00028000” will be supported as input.

 

5.3             March - May, 2010 – all symbols with OPRA roots cease to exist on the day of their respective consolidation, according to the OSI consolidation schedule available here.  Only consolidated symbols will be accepted as input parameters.  The option root symbol may be padded to 6 characters using either “space” or “^” (carrot sign).  Consolidated symbols returned in result sets.

 

Ex. “MSFT  100416C00028000” or “MSFT^^100416C00028000” will be supported as input parameters.

 

6.    optionsXpress Web Services Affected by the OSI:

http://oxbranch.optionsxpress.com/accountservice/account.asmx

              GetCustAccount

              GetCustActivityFM

              GetCustContingentOrders

              GetCustOrders

              GetCustOrderStatus

              GetCustPositionsBySymbol

              GetCustPositionsMini

              GetCustPositionsSOD

              GetCustPositionsSummary

              GetSecurityProfile

 

http://oxbranch.optionsxpress.com/accountservice/advancedorder.asmx

              PlaceCNTOOrder

              PlaceContingentMultiLegOrder

              PlaceContingentOptionOrder

              PlaceGenericOCOOTOOrder

              PlaceTrailingStopOptionOrder

 

http://oxbranch.optionsxpress.com/accountservice/order.asmx

              GetGenericQuote

              GetGenericQuoteFM

              GetGenericQuoteMulti

              PlaceContingentOptionOrder

              PlaceContingentOptionTimeOrder

              PlaceContingentOptionVolumeOrder

              PlaceMultiLegOrder

              PlaceOptionOrder

              PlaceOptionOrderWithRoute

              PlaceSpreadOrder

              PlaceTrailingStopOptionOrder

http://oxbranch.optionsxpress.com/accountservice/tools.asmx

              SymbolLookup

 

http://oxbranch.optionsxpress.com/accountservice/trade/basketorder.asmx

              AddMultiLegOrderToBasket

              AddOrderToBasket

              CreateNewBasket

              DeleteBasket

              DeleteOrderFromBasket

              GetBaskets

              GetOrderBySavedOrderId

              GetOrdersByBasketId

 

http://oxbranch.optionsxpress.com/opxstools/dragon.asmx

              GetOptionDragon

 

http://oxbranch.optionsxpress.com/opxstools/optionchain.asmx

              GetListOfValidMonths

              GetOptionChain

              GetOptionChainAll

              GetOptionChainWithIndicator

              GetOptionStrikesBySymbol

              GetPricerChain

 

http://oxbranch.optionsxpress.com/opxstools/quotedetail.asmx

              QuoteDetailService

 

http://oxbranch.optionsxpress.com/opxstools/screener.asmx

              RTSpreadScreener

              TradingPatternsDetailed

 

http://oxbranch.optionsxpress.com/opxstools/watchlist.asmx

              CreateNewWatchList

              DeleteWatchList

              DeleteWatchSymbols

              GetWatchSymbols

              GetWatchSymbolsWithQuotes

              ReCalibrateAlerts

              ReturnListOfWatches

              SaveWatchSymbols

              UpdateIndex

 

 

4 / 5

 

311 W. Monroe • Suite 1000 • Chicago, IL 60606-4661www.optionsxpress.com • 888-280-8020 • 312-629-5455 • Fax 312-629-5256

 


No comments: