Overview
This is a REST web API for end-of-day financial market data and uses 256 bit SSL encryption through https.
Authentication
Requests require a UserId/UserNum pair to be provided with every request. If you do not have one, please contact commercial sales. CSI must also set up your account with the contracted entitlements.
HTTP Status Code Responses
Response
- 
            200 OkThe request has succeeded. 
- 
            400 Bad RequestThe request was invalid. See the message for more information. 
- 
            401 UnauthorizedThe UserId is not authorized. See the message for more information. 
- 
            500 Internal Server ErrorThe server experienced an error. Please contact customer support. 
Error Message Responses
Response
- 
            successSuccess 
- 
            missing_useridThe UserId parameter is missing. 
- 
            missing_usernumThe UserNum parameter is missing. 
- 
            invalid_useridYour UserId is not valid. 
- 
            invalid_usernumYour UserNum is not valid. 
- 
            inactive_useridYour UserId is not active. 
- 
            no_packageNo package enabled. 
- 
            not_entitledYour UserId is not entitled for this endpoint. 
- 
            data_not_readyThe data is not ready. 
- 
            blocked_ip_addressBlocked IP Address. 
- 
            blocked_mac_addressBlocked Mac Address. 
- 
            rate_limit_exceededRate Limit Exceeded. 
- 
            missing_dateMissing date attribute. 
- 
            invalid_dateInvalid date attribute. 
- 
            invalid_formatInvalid format attribute. 
- 
            no_api_accessWeb api access is not enabled. 
- 
            missing_csinumCsinum is missing. 
- 
            invalid_csinumCsinum is invalid. 
- 
            custom_errorMessage varies. 
- 
            symbol_not_foundThe symbol cannot be found. 
- 
            portfolio_is_emptyThe portfolio is empty. 
- 
            not_entitled_for_csinumYour UserId is not entitled for this csinum. 
- 
            not_entitled_for_dateYour UserId is not entitled for this date. 
- 
            not_entitled_for_portYour UserId is not entitled for this portfolio. 
- 
            db_connect_errorError connecting to the database. 
- 
            call_limit_exceededYour monthly call limit has been exceeded. 
Header Row
Response
- 
To show a header row for CSV requests, inculde the ShowHeader=1 parameter. This will only work for endpoints that return one record type.
    
Overview
The call limit is 3000 requests per month for all endpoints combined. If you exceed this limit a call_limit_exceeded error will be returned.
Futures Factsheet
Returns factsheet data for all futures. View the html version here.
More information on point and tick values.
 More information on units and contract values.
Request
- 
            Formatoptional stringSpecify csv or html format. The default is csv. 
- 
            Csinumoptional integerReturns one future record. The csinum and DM code must both be provided together. 
- 
            DMoptional integerReturns one future record. The csinum and DM code must both be provided together. 
- 
            ExchangeCodeoptional stringReturns futures of a given exchange code and symbol. The ExchangeCode and ExchangeSymbol must both be provided together. 
- 
            ExchangeSymboloptional stringReturns futures of a given exchange code and symbol. The ExchangeCode and ExchangeSymbol must both be provided together. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DMCodeintegerThe secondary unique identifier. 
- 
            SymbolstringThe CSI futures symbol. 
- 
            NamestringThe name. 
- 
            ExchangeCodestringThe exchange code identifier. See the futures exchange codes. 
- 
            IsActivebooleanThis flag designates if the future is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            StartDateWithMappingdateThe first date of trading history when the history is extended with other series. 
- 
            UnitNumeratorMultiplierdecimalThe multiplier for the unit numerator. 
- 
            CurrencyCodestring(3)The trading currency. See the currencies. 
- 
            ContractSizedecimalThe size of the contract as a decimal number. 
- 
            UnitDenominatorMultiplierdecimalThe multiplier for the unit denominator. 
- 
            UnitDenominatorTypeIdintegerThe type ID for the unit denominator. See Unit Denominator Types. 
- 
            MinimumTickdecimalThe minimum tick size displayed in points format. 
- 
            TickValuedecimalThe value of one tick. 
- 
            FractionalPointValuedecimalThe value of one CSI point. 
- 
            FullPointValuedecimalThe value of 1.00 of price movement. 
- 
            PriceLimitdecimalThe price limit. 
- 
            CategoryintegerThe futures category identifier. See futures categories. 
- 
            SessionTypeintegerThe type of session. 1 for RTH (regular trading hours), 2 for ETH (extended/electronic trading hours), and 3 for combined session. 
- 
            CloseTypeintegerIndicates the type of price in the close field, 0 for settlements and 1 for lasts. 
- 
            ExchangeSymbolstringThe symbol used on the exchange. This usually matches the CSI symbol. 
- 
            ConversionFactorsigned integerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            HasImplied5BooleanIndicates if CSI points format require an implied 5. 
- 
            ValidDeliveryMonthsstring(12)The historical valid delivery months. The valid (V), invalid (I), and switching (S) months. Valid months are always available for trading by the exchange, invalid months are not available for trading, and switching months are sometimes available. The characters are presented in the 1-12 month order 'JFMAMJJASOND'. 
- 
            HasCurrentDayVolumeBooleanIndicates if CSI has current day volume coverage. 
- 
            HasCurrentDayOpenInterestBooleanIndicates if CSI has current day open interest coverage. 
- 
            HasKnownExpirationDatesBooleanIndicates if CSI has expiration date coverage. 
- 
            UnderlyingStockintegerThe underlying stock csinum for futures which are based on stocks or indices. See the stock factsheet. 
- 
            SessionGroupIdintegerIdentifier for futures with multiple sessions. 
- 
            UACsinumintegerThe unique identifier used in Unfair Advantage. 
- 
            TradingHoursStarttimeThe time that trading starts on the exchange. 
- 
            TradingHoursEndtimeThe time that trading ends on the exchange. 
- 
            ContractSizeTextstringThe size of the contract as text. 
- 
            PerpetualIsDifferentbooleanThis is only valid when DMCode is 0. It tells which Csinums have DMCode series that are not perpetual data, such as most Forex and LME. 
- 
            FootnotestringA footnote containing any significant events in the market history. 
- 
            BBGTickerstringThe BBG root ticker. 
- 
            BBGYellowKeystringThe BBG yellow key. 
- 
            OhlcOffsetintegerThere are some markets that go negative and previously CSI could not support storing negative numbers. An offset needs to be applied. Subtract this offset (with the conversion factor applied) from the CSI price to get the actual price. Newer file formats do not require this. 
- 
            EnergyGroupNamestringThe root name for energy futures that have multiple delivery intervals. 
- 
            CurrentValidDeliveryMonthsstring(12)The current valid delivery months. The valid (V), invalid (I), and switching (S) months. Valid months are always available for trading by the exchange, invalid months are not available for trading, and switching months are sometimes available. The characters are presented in the 1-12 month order 'JFMAMJJASOND'. 
- 
            MinimumTickSizedecimalThe minimum tick size displayed in decimal format. 
API Endpoint
https://apps.csidata.com/FuturesFactsheetRequest Example
https://apps.csidata.com/FuturesFactsheet?Format=csv&ShowHeader=1Response Example
Futures Price History
Returns raw historical futures price data that is unadjusted.
Request
- 
            CsinumintegerThe unique identifier. 
- 
            DYoptional integerThe delivery year. 
- 
            DMoptional integerThe delivery month. 
- 
            Start Dateoptional dateThe start date of history to return. 
- 
            End Dateoptional dateThe end date of history to return. 
Response
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            Dateoptional dateThe trade date. 
- 
            OpendecimalThe open price. 
- 
            HighdecimalThe high price. 
- 
            LowdecimalThe low price. 
- 
            ClosedecimalThe close price. 
- 
            VolumedecimalThe volume. 
- 
            OIdecimalThe open interest. 
API Endpoint
https://apps.csidata.com/FuturesHistoryRequest Example
https://apps.csidata.com/FuturesHistory?Csinum=2&DY=2019&DM=12Response Example
Futures Delivery Months
Returns all delivery months for a given future.
Request
- 
            CsinumintegerThe unique identifier. 
- 
            Start Dateoptional dateThe start date of history to return. 
- 
            End Dateoptional dateThe end date of history to return. 
Response
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
API Endpoint
https://apps.csidata.com/FuturesHistoryDeliveryMonthsRequest Example
https://apps.csidata.com/FuturesHistoryDeliveryMonths?Csinum=2Response Example
Cash Factsheet
Returns factsheet data for cash markets.
Request
- 
            formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DMCodeintegerThe secondary unique identifier. 
- 
            SymbolstringThe CSI symbol. 
- 
            NamestringThe name. 
- 
            ExchangeCodestringThe exchange code identifier. See the futures exchange codes. 
- 
            IsActivebooleanThis flag designates if the cash market is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            StartDateWithMappingdateThe first date of trading history when the history is extended with other series. 
- 
            UnitNumeratorMultiplierdecimalThe multiplier for the unit numerator (typically the currency). 
- 
            CurrencyCodestring(3)The trading currency. See the currencies. 
- 
            UnitDenominatorMultiplierdecimalThe multiplier for the unit denominator (typically the contract size). 
- 
            UnitDenominatorTypeIdintegerThe type ID for the unit denominator (typically the contract size). See futures units. 
- 
            ConversionFactorsigned integerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            UACsinumintegerThe unique identifier used in Unfair Advantage. 
- 
            FootnotebooleanAny notable events or details about the market. 
API Endpoint
https://apps.csidata.com/CashFactsheetRequest Example
https://apps.csidata.com/CashFactsheet?format=csvResponse Example
Futures and Options Exchanges
Returns the exchanges that provide futures and options.
Response
- 
            ExchangeCodestringThe unique identifier. 
- 
            NamestringThe exchange name. 
- 
            HasFuturesBooleanThe exchange has futures. 
- 
            HasFuturesOptionsBooleanThe exchange has futures options. 
- 
            HasStockOptionsBooleanThe exchange has stock options. 
- 
            ParentExchangeCodestringThe parent exchange code. 
- 
            IsOldExchangebooleanThis flag designates if the exchange no longer exists. 
- 
            ISOCountryCodestringThe ISO country code. 
API Endpoint
https://apps.csidata.com/FuturesExchangesRequest Example
https://apps.csidata.com/FuturesExchangesResponse Example
Unit Denominator Types
Returns the unit denominator types for futures that are used in the futures factsheet.
Response
- 
            UnitDenominatorTypeIDintegerThe unique identifier. 
- 
            NamestringThe type name. 
- 
            AbbreviationstringThe abbreviation. 
API Endpoint
https://apps.csidata.com/UnitDenominatorTypesRequest Example
https://apps.csidata.com/UnitDenominatorTypesResponse Example
Futures Categories
Returns the futures categories that are used in the futures factsheet.
Response
- 
            FuturesCategoryIDintegerThe unique identifier. 
- 
            NamestringThe category name. 
- 
            AssetClassIdintegerThe asset class identifier. 
API Endpoint
https://apps.csidata.com/FuturesCategoriesRequest Example
https://apps.csidata.com/FuturesCategoriesResponse Example
Asset Classes
Returns the asset classes used for classifying futures.
Response
- 
            AssetClassIdintegerThe unique identifier. 
- 
            NamestringThe name. 
API Endpoint
https://apps.csidata.com/AssetClassesRequest Example
https://apps.csidata.com/AssetClassesResponse Example
Footnotes
Returns footnotes for futures and stocks.
Response
- 
            FootnoteIDintegerThe unique identifier. 
- 
            DescriptionstringThe footnote description. 
API Endpoint
https://apps.csidata.com/FootnotesRequest Example
https://apps.csidata.com/FootnotesResponse Example
Futures Footnote Mappings
Returns the footnote mappings for futures. See footnotes for the actual footnotes. View the html version here.
Request
- 
            Formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DMintegerThe DM code. 
- 
            FootnoteIDintegerThe footnote ID. 
API Endpoint
https://apps.csidata.com/FuturesFootnotesRequest Example
https://apps.csidata.com/FuturesFootnotesResponse Example
Contract Dates
Important dates for futures and options contracts.
Futures Coverage
- Notice, Delivery Dates – Back to 2017 for ICE and CME exchanges. Notice dates to March 2020 are available for Montreal Exchange.
- Trade Dates – Back to 2017 for about 80% of active futures.
- CSI Dates – All contracts for all futures.
- Expiration Dates – Back to late 2001. Most active futures and about 80% of inactive futures.
Futures Options Coverage
- Notice, Delivery Dates – None.
- Trade Dates – Back to 2017. About 70% of active options.
- CSI Dates – All contracts for all options.
- Expiration Dates – Back to late 2001. About 70% of active options and half of inactive.
Request
- 
            Typeoptional stringSpecify Futures or Options. The default is Futures. 
- 
            HideExpiredContractsoptional booleanSpecify HideExpiredContracts=1 to prevent all expired contracts from being included. The default is false. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            FirstNoticeDatedateThe first notice date. 
- 
            LastNoticeDatedateThe last notice date. 
- 
            FirstDeliveryDatedateThe first delivery date. 
- 
            LastDeliveryDatedateThe last delivery date. 
- 
            FirstTradeDatedateThe first date available for trading. 
- 
            LastTradeDatedateThe last date available for trading. 
- 
            FirstCsiDatedateThe first date in CSI's price history. 
- 
            LastCsiDatedateThe last date in CSI's price history 
- 
            ExpirationDatedateThe date the contract expires. 
- 
            LastCsiDateWithPricesdateThe last date in CSI's price history that has a settlement price. 
API Endpoint
https://apps.csidata.com/ContractDatesRequest Example
https://apps.csidata.com/ContractDates?Type=FuturesResponse Example
Futures History Adjustments
Returns events where adjustments have been made to futures contract specifications. These adjustments can be applied to the history to produce continuous series. Incudes changes to currencies, coupon rates, contract sizes, and units, as well as stock index splits.
Response
- 
            ChangeTypestring(2)The unique identifier for the adjustment type 
- 
            CsinumintegerThe unique identifier for the future. 
- 
            AdjustmentStartDYintegerThe starting delivery year. 
- 
            AdjustmentStartDMintegerThe starting delivery month. 
- 
            AdjustmentEndDYintegerThe ending delivery year. 
- 
            AdjustmentEndDMintegerThe ending delivery month. 
- 
            AdjustmentStartDatedateThe start date. 
- 
            AdjustmentEndDatedateThe end date. 
- 
            AdjustOHLCbooleanFlag indicates if adjustment should be applied to the open, high, low, and close prices. 
- 
            AdjustVolbooleanFlag indicates if the adjustment should be applied to the volume. 
- 
            AdjustOIbooleanFlag indicates if the adjustment should be applied to the open interest. 
- 
            AdjustmentdecimalThe adjustment that should be applied to the range of data falling within the start/end dates and start/end delivery months. If this value is null(empty) and the type is CT (currency type change), then the adjustment factors are the forex prices for the currencies in the Value and SubsequentValue fields. 
- 
            FootnoteIdintegerThe unique identifier for the footnote. 
- 
            ValuestringThe value before the change event. 
- 
            SubsequentValuestringThe value after the change event. 
API Endpoint
https://apps.csidata.com/FuturesHistoryAdjustmentsRequest Example
https://apps.csidata.com/FuturesHistoryAdjustmentsResponse Example
History Adjustment Types
Returns the types for the Futures History Adjustments.
Response
- 
            TypeIdstring(2)The unique identifier. 
- 
            DescriptionstringThe description. 
API Endpoint
https://apps.csidata.com/HistoryAdjustmentTypesRequest Example
https://apps.csidata.com/HistoryAdjustmentTypesResponse Example
Futures History Mappings
Returns mappings that can be used to extend futures history series farther into the past.
Response
- 
            MappingIdintegerThe unique identifier of the mapping record. 
- 
            FromCsinumintegerThe csinum from which to take the history. 
- 
            ToCsinumintegerThe csinum where the history should be appended to. 
- 
            FromDYintegerThe delivery year of the FromCsinum to start taking history. 
- 
            FromDMintegerThe delivery month of the FromCsinum to start taking history. 
- 
            ToDYintegerThe delivery year of the FromCsinum to stop taking history. 
- 
            ToDMintegerThe delivery month of the FromCsinum to stop taking history. 
- 
            StartDatedateThe start date of the FromCsinum to use. 
- 
            EndDatedateThe end date of the FromCsinum to use. 
API Endpoint
https://apps.csidata.com/FuturesHistoryMappingsRequest Example
https://apps.csidata.com/FuturesHistoryMappingsResponse Example
Stock Factsheet
Returns factsheet data for all stocks, indices, and mutual funds. View the html version here.
Request
- 
            Formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            SymbolstringThe stock symbol. 
- 
            NamestringThe name. 
- 
            ExchangeCodestringThe exchange code identifier. See the stock exchange codes. 
- 
            IsActivebooleanThis flag designates if the stock is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            TypeIdstringThe type identifier. See the stock types. 
- 
            CurrencyCodestringThe trading currency. See the currencies. 
- 
            SectorIdstringThe stock sector identifier. 
- 
            IndustryIdstringThe stock industry identifier. 
- 
            ExchangeSymbolstringThe symbol used on the exchange. 
- 
            ConversionFactorsigned integerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            PreSwitchConversionFactorsigned integerThe conversion factor prior to the date it changed. 
- 
            ConversionFactorSwitchDatedateThe date when the conversion factor changed. 
- 
            VolumeDivisorintegerThe volume divisor used to store volumes in the internal CSI database. 
- 
            LegacyExchangeCodestringA broader exchange code. Possible values are NASDAQ, AMEX, NYSE, TSX, TSXV, MUTUAL, INDEX, and FINDEX. OTC markets are labeled under NASDAQ. 
API Endpoint
https://apps.csidata.com/StockFactsheetRequest Example
https://apps.csidata.com/StockFactsheet?Format=csvResponse Example
Stock Types
Returns all of the stock types.
Request
- 
            formatoptional stringSpecify csv or json format. The default is csv. 
Response
- 
            StockTypeIdstring(3)The stock type identifier. 
- 
            NamestringThe stock type description. 
API Endpoint
https://apps.csidata.com/StockTypesRequest Example
https://apps.csidata.com/StockTypes?format=csvResponse Example
Stock Exchanges
Returns all of the stock exchanges.
Request
- 
            formatoptional stringSpecify csv or json format. The default is csv. 
Response
- 
            ExchangeCodestring(3)The exchange code identifier. 
- 
            NamestringThe exchange name. 
API Endpoint
https://apps.csidata.com/StockExchangesRequest Example
https://apps.csidata.com/StockExchanges?format=csvResponse Example
Stock/Index/Mutual fund Price History
Returns history for stocks, indexes, and mutual funds. This endpoint has no options for adjusting. The start date of available history is set by your agreement with CSI, please contact us for additional history.
Request
- 
            CsinumintegerThe request csinum. Either the csinum or symbol is required. See all available csinums in the stock factsheet. 
- 
            StartDateoptional dateThe start date in YYYYMMDD format. 
- 
            EndDateoptional dateThe end date in YYYYMMDD format. 
Response
For stocks and indices:- 
            TradeDatedateThe unique stock identifier. 
- 
            OpendecimalOpen price. 
- 
            HighdecimalHigh price. 
- 
            LowdecimalLow price. 
- 
            ClosedecimalClose price. 
- 
            VolumeintegerVolume. 
For mutual funds:
- 
            TradeDatedateThe unique stock identifier. 
- 
            NAVdecimalThe net asset value. 
API Endpoint
https://apps.csidata.com/StockHistRawRequest Example1
https://apps.csidata.com/StockHistRaw?Csinum=5110Response Example1
Stock/Index/Mutual fund Price History with Adjustments
Returns history for stocks, indexes, and mutual funds. All price history, splits, dividends, and capital gains are returned. The start date of available history is set by your agreement with CSI, please contact us for additional history.
Request
- 
            CsinumintegerThe request csinum. Either the csinum or symbol is required. See all available csinums in the stock factsheet. 
- 
            SymbolstringThe request stock symbol. Either the csinum or symbol is required. Append the following to the symbol for Non-US stocks. 
 "-L" for London Stock Exchange
 "-T" for Toronto Stock Exchange
 "-V" for TSX Venture Exchange
- 
            StartDateoptional dateThe start date in YYYYMMDD format. 
- 
            EndDateoptional dateThe end date in YYYYMMDD format. 
- 
            AdjustForSplitsoptional booleanUse 1 to specify that the history should be split adjusted. 
- 
            AdjustForDividendsFixedoptional booleanUse 1 to specify that the history should be adjusted by subtracting the cumulative dividends from the price going back in time. Using this method it is possible to see negative prices. 
- 
            AdjustForDividendsProportionaloptional booleanUse 1 to specify that the history should be adjusted for dividends proportionally. This means that for each dividend, a ratio is computed from the previous close. The prices get multiplied by this cumulative ratio going back in time. 
- 
            AdjustForCapitalGainsFixedoptional booleanOnly applies to mutual funds. Use 1 to specify that the history should be adjusted by subtracting the cumulative capital gains from the price going back in time. Using this method it is possible to see negative prices. 
- 
            AdjustForCapitalGainsProportionaloptional booleanOnly applies to mutual funds. Use 1 to specify that the history should be adjusted for capital gains proportionally. This means that for each dividend, a ratio is computed from the previous NAV. This cumulative ratio is applied back in time. 
- 
            DivideVolumeoptional booleanOnly applies to mutual funds. Use 1 to specify that the history should be adjusted for capital gains proportionally. This means that for each capital gain, a ratio is computed from the previous NAV. The NAVs get multiplied by this cumulative ratio going back in time. 
Response
- 
            Record Type: 70Header record. 
- 
            TypeFlagintegerFile type flag. ‘2’ for history. 
- 
            UserIdstring(3)The requested UserId. 
- 
            CreationDatedateCreation date in YYMMDD format. 
- 
            CreationTimetimeCreation time in HHMMSS format. 
- 
            RecordCountintegerRecord count, including header and trailer records. 
- 
            Record Type: 71History Header Record. 
- 
            SymbolstringThe symbol. 
- 
            CsinumintegerThe csinum. 
- 
            unused1
- 
            unused2
- 
            NPCFlagcharNormal/Put/Call flag will show N/P/C respectively. 
- 
            StrikedecimalStrike price when displaying options. 
- 
            FrequencycharDaily/Weekly/Monthly flag will show D/W/M respectively. 
- 
            FirstDatedateFirst date in file (CCYYMMDD format). 
- 
            LastDatedateLast date in file (CCYYMMDD format). 
- 
            CFintegerConversion factor. 
- 
            NumDaysintegerNumber of days in the file. 
- 
            Record Type: 73Stock price record in points. 
- 
            Same as type 83, with prices in points format. 
- 
            Record Type: 76Mutual fund record in points. 
- 
            Same as type 86, with prices in points format. 
- 
            Record Type: 83Stock price record in decimal. 
- 
            DatedateDate of data in CCYYMMDD format. 
- 
            CsinumintegerThe csinum. 
- 
            OpendecimalOpen price. 
- 
            HighdecimalHigh price. 
- 
            LowdecimalLow price. 
- 
            ClosedecimalClose price. 
- 
            VolumeintegerVolume. 
- 
            Record Type: 86Mutual fund record in decimal. 
- 
            DatedateDate of data in CCYYMMDD format. 
- 
            NAVdecimalNet asset value. 
- 
            Record Type: 97Dividend/capital gain record. 
- 
            ExDatedateEx-dividend date in CCYYMMDD format. 
- 
            DividenddecimalDividend amount. 
- 
            CapitalGaindecimalCapital gain amount. 
- 
            Record Type: 98Stock split record. 
- 
            SplitDatedateSplit date in CCYYMMDD format. 
- 
            NewSharesintegerNumber of new shares. 
- 
            OldSharesintegerNumber of old shares. 
API Endpoint
https://apps.csidata.com/StockHistRequest Example
https://apps.csidata.com/StockHist?Csinum=5110&AdjustForSplits=1&AdjustForDividendsProportional=1Response Example
Stock Daily Adjusted
Returns one day of price data for stocks, indexes, and mutual funds in historical format. It allows prices to be adjusted for splits, dividends, and capital gains. This can also include adjusted correction records.
Request
- 
            RequestDatedateThe request date in YYYYMMDD format. It must be within the last 40 days. 
- 
            AdjustForSplitsoptional booleanUse 1 to specify that the history should be split adjusted. 
- 
            AdjustForDividendsFixedoptional booleanUse 1 to specify that the history should be adjusted by subtracting the cumulative dividends from the price going back in time. Using this method it is possible to see negative prices. 
- 
            AdjustForDividendsProportionaloptional booleanUse 1 to specify that the history should be adjusted for dividends proportionally. This means that for each dividend, a ratio is computed from the previous close. The prices get multiplied by this cumulative ratio going back in time. 
- 
            AdjustForCapitalGainsFixedoptional booleanOnly applies to mutual funds. Use 1 to specify that the history should be adjusted by subtracting the cumulative capital gains from the price going back in time. Using this method it is possible to see negative prices. 
- 
            AdjustForCapitalGainsProportionaloptional booleanOnly applies to mutual funds. Use 1 to specify that the history should be adjusted for capital gains proportionally. This means that for each capital gain, a ratio is computed from the previous NAV. The NAVs get multiplied by this cumulative ratio going back in time. 
- 
            DivideVolumeoptional booleanOnly applies to stocks and indices. Use 1 to specify that the volume should be divided by the VolumeDivisor from the stock factsheet. This is primarily for legacy use. 
- 
            IncludeCorrectionsoptional booleanUse 1 to include correction records in adjusted format. 
Response
- The same as the StockHistory response.
API Endpoint
https://apps.csidata.com/StockDailyAdjustedRequest Example1
https://apps.csidata.com/StockDailyAdjusted?RequestDate=20200114&AdjustForSplits=1Response Example1
Request Example2
https://apps.csidata.com/StockDailyAdjusted?RequestDate=20200113&AdjustForSplits=1Response Example2
Stock Corrections Adjusted
Returns split adjusted corrections for all stock price data, mutual fund NAVs, dividends, and capital gains.
Request
- 
            DateOfCorrectionsdateThe request date in YYYYMMDD format. 
Response
- 
            Record Type: 09Correct a past day of data. 
- 
            Data DatedateThe trade date for prices or the ex date for dividends and capital gains. 
- 
            Underlying Record Typeinteger33 for stock prices 
 36 for mutual fund navs
 37 for dividends and capital gains
- 
            Additional FieldsThe other fields are specified in the daily csv documentation for each underlying record type. 
- 
            Record Type: 13Delete a past day of data. 
- 
            Data DatedateDate to be deleted. 
- 
            SymbolstringThe stock or mutual fund symbol. 
- 
            CsinumintegerThe csinum identifier. 
- 
            Unused
- 
            Unused
- 
            Unused
API Endpoint
https://apps.csidata.com/StockCorrectionsAdjustedRequest Example
https://apps.csidata.com/StockCorrectionsAdjusted?DateOfCorrections=20210505Response Example
Stock Split History
Returns split history for stocks, mutual funds, and indices. The start date of available history is set by your agreement with CSI, please contact us for additional history.
Request
- 
            CsinumintegerThe request csinum. See all available csinums in the stock factsheet. 
- 
            StartDateoptional dateThe start date in YYYYMMDD format. 
- 
            EndDateoptional dateThe end date in YYYYMMDD format. 
Response
- 
            Ex DatedateThe date when the shares begin trading at post-split prices. 
- 
            New SharesintegerThe number of new shares after the split. For example, in a 2 for 1 split, every 1 (old) share held by traders is replaced with 2 (new) shares. 
- 
            Old SharesintegerThe number of old shares after the split. 
API Endpoint
https://apps.csidata.com/SplitsRequest Example
https://apps.csidata.com/Splits?csinum=5110Response Example
Stock Dividend History
Returns dividend history for stocks and mutual funds. The start date of available history is set by your agreement with CSI, please contact us for additional history.
Request
- 
            CsinumintegerThe request csinum. See all available csinums in the stock factsheet. 
- 
            StartDateoptional dateThe start date in YYYYMMDD format. 
- 
            EndDateoptional dateThe end date in YYYYMMDD format. 
Response
- 
            Ex DatedateThe date when the shares begin trading at post-distribution prices. 
- 
            DividenddecimalThe amount of the dividend. 
API Endpoint
https://apps.csidata.com/DividendsRequest Example
https://apps.csidata.com/Dividends?csinum=5970Response Example
Stock Dividend History
Returns capital gain history for mutual funds. The start date of available history is set by your agreement with CSI, please contact us for additional history.
Request
- 
            CsinumintegerThe request csinum. See all available csinums in the stock factsheet. 
- 
            StartDateoptional dateThe start date in YYYYMMDD format. 
- 
            EndDateoptional dateThe end date in YYYYMMDD format. 
Response
- 
            Ex DatedateThe date when the shares begin trading at post-distribution prices. 
- 
            DividenddecimalThe amount of the capital gain. This is the sum of long and short term. 
API Endpoint
https://apps.csidata.com/CapitalGainsRequest Example
https://apps.csidata.com/CapitalGains?csinum=1920Response Example
Stock Sectors
Returns all of the stock sectors.
Response
- 
            SectorIdstring(3)The unique identifier. 
- 
            SectorNamestringThe sector name. 
API Endpoint
https://apps.csidata.com/StockSectorsRequest Example
https://apps.csidata.com/StockSectorsResponse Example
Stock Industries
Returns all of the stock Industries.
Response
- 
            IndustryIdstring(3)The unique identifier. 
- 
            SectorIdstring(3)The unique identifier for the parent stock sector. 
- 
            IndustryNamestringThe sector name. 
API Endpoint
https://apps.csidata.com/StockSectorsRequest Example
https://apps.csidata.com/StockSectorsResponse Example
Shares Outstanding History
Returns history for all Shares Outstanding for most US Stocks.
Response
- 
            CsinumintegerThe stock csinum. 
- 
            SharesOutstandingintegerThe shares outstanding including split adjustments. 
- 
            EffectiveDatedateThe shares outstanding effective date. 
API Endpoint
https://apps.csidata.com/SharesOutstandingHistoryRequest Example
https://apps.csidata.com/SharesOutstandingHistoryResponse Example
Shares Outstanding Snapshot
Returns a snapshot with the most recent Shares Outstanding for each US Stock.
Response
- 
            CsinumintegerThe stock csinum. 
- 
            SharesOutstandingintegerThe shares outstanding including split adjustments. 
- 
            EffectiveDatedateThe shares outstanding effective date. 
API Endpoint
https://apps.csidata.com/SharesOutstandingSnapshotRequest Example
https://apps.csidata.com/SharesOutstandingSnapshotResponse Example
Futures Option Factsheet
Returns factsheet data for all futures options. View the html version here.
Request
- 
            formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            SymbolstringThe CSI symbol. 
- 
            NamestringThe name. 
- 
            ExchangeCodestringThe exchange code identifier. See the futures and options exchange codes. 
- 
            IsActivebooleanThis flag designates if the option is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            ValidDeliveryMonthsstring(12)The valid (V), invalid (I), and switching (S) months. 
- 
            ConversionFactorintegerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            DivideStrikeintegerUsed when converting a points representation strike to match the decimal futures price. For 0 the literal value is taken. For 1, the points price is divided by 10. For -1, the points price is multiplied by 10. 
- 
            Implied5PricesbooleanThis is also only needed when converting CSI's point representation to decimal. This means to append a '5' to any terminal digit that is a '2' or a '7'. 
- 
            Implied5StrikesbooleanThis is also only needed when converting CSI's point representation to decimal. This means to append a '5' to any terminal digit that is a '2' or a '7'. 
- 
            ContractSizedecimalThe size of the contract as a decimal number. 
- 
            MinimumTickdecimalThe minimum tick defined by the exchange. 
- 
            TickValuedecimalThe value of one tick. 
- 
            FractionalPointValuedecimalThe value of one CSI point. 
- 
            FullPointValuedecimalThe value of 1.00 of price movement. 
- 
            CurrencystringThe trading currency. See the currencies. 
- 
            ParentCsinumintegerThe parent CSI number that contains the normal monthly options. 
- 
            ExchangeSymbolstringThe symbol used on the exchange. 
- 
            TradingHoursStarttimeThe time that trading starts on the exchange. 
- 
            TradingHoursEndtimeThe time that trading ends on the exchange. 
API Endpoint
https://apps.csidata.com/FuturesOptionFactsheetRequest Example
https://apps.csidata.com/FuturesOptionFactsheet?Format=csvResponse Example
Stock Option Factsheet
Returns factsheet data for all stock options. View the html version here.
Request
- 
            Formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            SymbolstringThe CSI symbol. 
- 
            NamestringThe name. 
- 
            ExchangeCodestringThe exchange code identifier. See the futures and options exchange codes. 
- 
            IsActivebooleanThis flag designates if the option is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            ConversionFactorintegerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            DivideStrikeintegerUsed when converting a points representation strike to match the decimal futures price. For 0 the literal value is taken. For 1, the points price is divided by 10. For -1, the points price is multiplied by 10. 
- 
            Implied5PricesbooleanThis is also only needed when converting CSI's point representation to decimal. This means to append a '5' to any terminal digit that is a '2' or a '7'. 
- 
            Implied5StrikesbooleanThis is also only needed when converting CSI's point representation to decimal. This means to append a '5' to any terminal digit that is a '2' or a '7'. 
API Endpoint
https://apps.csidata.com/StockOptionFactsheetRequest Example
https://apps.csidata.com/StockOptionFactsheet?Format=csvResponse Example
Futures Options Price History
Returns historical futures options price data.
Request
- 
            CsinumintegerThe unique identifier. 
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            Strikeoptional decimalThe strike. 
- 
            Start Dateoptional dateThe start date of history to return. 
- 
            End Dateoptional dateThe end date of history to return. 
Response
- 
            Put/Call FlagcharP for put, C for call. 
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            StrikedecimalThe strike price. 
- 
            DatedateThe trade date. 
- 
            OpendecimalThe open price. This field was not supported prior to July 1st, 2021 and will be blank. 
- 
            HighdecimalThe high price. 
- 
            LowdecimalThe low price. 
- 
            ClosedecimalThe close price. 
- 
            VolumedecimalThe volume. 
- 
            OIdecimalThe open interest. 
API Endpoint
https://apps.csidata.com/OptionsHistoryRequest Example
https://apps.csidata.com/OptionsHistory?Csinum=2&DY=2019&DM=12Response Example
Stock Options Price History
Returns historical stock options price data.
Request
- 
            CsinumintegerThe unique identifier. 
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            Strikeoptional decimalThe strike. 
- 
            Start Dateoptional dateThe start date of history to return. 
- 
            End Dateoptional dateThe end date of history to return. 
Response
- 
            Put/Call FlagcharP for put, C for call. 
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            StrikedecimalThe strike price. 
- 
            DatedateThe trade date. 
- 
            HighdecimalThe high price. 
- 
            LowdecimalThe low price. 
- 
            ClosedecimalThe close price. 
- 
            BiddecimalThe bid price. 
- 
            AskdecimalThe ask price. 
- 
            VolumedecimalThe volume. 
- 
            OIdecimalThe open interest. 
API Endpoint
https://apps.csidata.com/StockOptionsHistoryRequest Example
https://apps.csidata.com/StockOptionsHistory?Csinum=5676&DY=2019&DM=12Response Example
Option Contract Underliers
Returns the underlying instrument for options contracts.
Response
- 
            CsinumintegerThe csinum. 
- 
            DYintegerThe delivery year. 
- 
            DMintegerThe delivery month. 
- 
            Underlier TypecharThe type of underlier. 'C' for commodity, 'S' for stock. 
- 
            Underlier CsinumintegerThe underlying csinum. 
- 
            Underlier DYintegerThe underlying delivery year. 
- 
            Underlier DMintegerThe underlying delivery month. 
API Endpoint
https://apps.csidata.com/OptionContractUnderliersRequest Example
https://apps.csidata.com/OptionContractUnderliersResponse Example
Forex Factsheet
Returns factsheet data for all forex markets.
Request
- 
            formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DMCodeintegerThe secondary unique identifier. 
- 
            Currency1string(3)The first currency of the excahnge rate pair. See Currencies. 
- 
            Currency2string(3)The second currency of the excahnge rate pair. See Currencies. 
- 
            NamestringThe name description. 
- 
            IsActivebooleanThis flag designates if the forex market is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            SymbolstringThe CSI symbol. 
- 
            ConversionFactorsigned integerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            UACsinumintegerThe unique identifier used in Unfair Advantage. 
API Endpoint
https://apps.csidata.com/ForexFactsheetRequest Example
https://apps.csidata.com/ForexFactsheet?format=csvResponse Example
Government Rates Factsheet
Returns factsheet data for all government rates.
Request
- 
            formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DMCodeintegerThe secondary unique identifier. 
- 
            Currencystring(3)The currency. See Currencies. 
- 
            NamestringThe name description. 
- 
            IsActivebooleanThis flag designates if the series is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            SymbolstringThe CSI symbol. 
- 
            ConversionFactorsigned integerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            UACsinumintegerThe unique identifier used in Unfair Advantage. 
API Endpoint
https://apps.csidata.com/GovtRatesFactsheetRequest Example
https://apps.csidata.com/GovtRatesFactsheet?format=csvResponse Example
Economic Statistics Factsheet
Returns factsheet data for all economic statistics.
Request
- 
            formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            DMCodeintegerThe secondary unique identifier. 
- 
            Currencystring(3)The currency. See Currencies. 
- 
            NamestringThe name description. 
- 
            IsActivebooleanThis flag designates if the series is active or not. 
- 
            StartDatedateThe first date of trading history. 
- 
            EndDatedateThe last date of trading history. 
- 
            SymbolstringThe CSI symbol. 
- 
            ConversionFactorsigned integerThe current conversion factor used for converting prices in points format. See conversion factors. 
- 
            UACsinumintegerThe unique identifier used in Unfair Advantage. 
API Endpoint
https://apps.csidata.com/EconStatsFactsheetRequest Example
https://apps.csidata.com/EconStatsFactsheet?format=csvResponse Example
Stock Footnote Mappings
Returns the footnote mappings for stocks. See footnotes for the actual footnotes. View the html version here.
Request
- 
            Formatoptional stringSpecify csv or html format. The default is csv. 
Response
- 
            CsinumintegerThe unique identifier. 
- 
            FootnoteIDintegerThe footnote ID. 
API Endpoint
https://apps.csidata.com/StockFootnotesRequest Example
https://apps.csidata.com/StockFootnotesResponse Example
Daily File
Returns a daily file with a preset portfolio of stocks, futures, and options. To create or modify the contents of the portfolio, please contact CSI support. Each portfolio is designed to be ready for download at a specific data posting. Access the LatestPosting endpoint and wait for that integer to change to the required posting ID. For example, if the portfolio contains asia markets, wait until the LatestPosting ID shows 1.
Request
- 
            user or UserIdrequired stringThe UserId. 
- 
            num or UserNumrequired integerThe user number. 
- 
            daterequired dateThe date of data in YYYYMMDD format. 
- 
            portrequired stringThe Id of the portfolio. Your account must be entitled for it. The preset stock portfolios are below: G51 NYSE G52 AMEX G53 NASDAQ G54 US Indices G55 Canada Stocks G56 London Stocks G57 Mutual Funds G58 Foreign Indices G59 North American Stocks, Mutuals, World Indices G60 US Stocks, no funds G61 US ETF G62 Canada ETF G63 London ETF G64 US ETN 
- 
            NoFAoptional booleanUse 1 to not return the file as an attachment. 
Response
API Endpoint
https://apps.csidata.com/DailyRequest Example
https://apps.csidata.com/Daily?user=ABC&num=12345&port=ABC&date=19951228Response Example
Data Postings
Returns all of the data release groups.
- For futures, the PostingId of 1 means all futures of Asian exchanges are final, 2 is all European exchanges, 4 is all world futures with preliminary CME, and greater or equal 6 is all world futures with final CME.
- US stocks have preliminary OHLC and volume at posting 3. Then final OHLC and preliminary volume at posting 5. Corrections are sent the following morning for final volume which includes after hours trading.
- All options and cash are final at posting 6.
Response
- 
            PostingIdintegerThe posting identifier. 
- 
            DescriptionstringThe data release description. 
- 
            AverageReleaseTimetimeThe average release time in Eastern Time. 
API Endpoint
https://apps.csidata.com/DataPostingsRequest Example
https://apps.csidata.com/DataPostingsResponse Example
Latest Posting
Returns the latest posting for a given date.
Request
- 
            RequestDaterequired dateThe date of the request in YYYYMMDD format. 
Response
- 
            PostingIdintegerThe data posting identifier. 
API Endpoint
https://apps.csidata.com/LatestPostingRequest Example
https://apps.csidata.com/LatestPosting?RequestDate=20190624Response Example
Data Updates
Request
- 
            RequestDateDateThe request date in YYYYMMDD format. 
Response
- 
            HistoryHasBeenUpdatedbooleanIndicates when the historical database has been updated from the daily data files. This normally occurs around 8:10-8:30pmET. 
- 
            StockVolumesHaveBeenUpdatedbooleanIndicates when stock volume corrections have been posted. This normally occurs around 9:30amET. 
- 
            HistoryHasBeenUpdatedNextDaybooleanIndicates when futures and options corrections have been applied to the daily and historical data. This normally occurs around 1:30pmET the following day. 
API Endpoint
https://apps.csidata.com/DataUpdatesRequest Example
https://apps.csidata.com/DataUpdates?RequestDate=20200207Response Example
Currency Catalog
Returns all of the currencies.
Response
- 
            CurrencyCodestring(3)The currency code. 
- 
            NamestringThe description. 
- 
            IsCryptobooleanDesignates that the currency is a cryptocurrency. 
API Endpoint
https://apps.csidata.com/CurrenciesRequest Example
https://apps.csidata.com/CurrenciesResponse Example
Conversion Factors
Returns all of the conversion factors used to convert prices to/from decimal and points formal. Click here for more information.
Response
- 
            ConversionFactorIdsigned integerThe conversion factor ID. 
- 
            DescriptionstringThe description. 
API Endpoint
https://apps.csidata.com/ConversionFactorsRequest Example
https://apps.csidata.com/ConversionFactorsResponse Example
Countries
Returns all of the countries.
Response
- 
            CountryIdintegerThe country ID. 
- 
            ISOCountryCodestringThe ISO country code. 
- 
            NamestringThe country name. 
- 
            CurrencystringThe primary currency used by the country. 
API Endpoint
https://apps.csidata.com/CountriesRequest Example
https://apps.csidata.com/CountriesResponse Example
API Endpoint
https://apps.csidata.com/ExchangeCountriesRequest Example
https://apps.csidata.com/ExchangeCountriesResponse Example
Holidays
All of the available holidays.
Response
- 
            HolidayIdintegerThe holiday ID. 
- 
            DescriptionstringDescription of the holiday. 
API Endpoint
https://apps.csidata.com/HolidaysRequest Example
https://apps.csidata.com/HolidaysResponse Example
API Endpoint
https://apps.csidata.com/HolidayMappingsRequest Example
https://apps.csidata.com/HolidayMappingsResponse Example
Holiday Confirmations
These are confirmed holidays for specific markets. History is not available before 2020.
Response
- 
            CsinumintegerThe market identifier. 
- 
            IsOptionbooleanIndicates if the market is an option. 
- 
            HolidayDatedateThe date where there is no trading. 
API Endpoint
https://apps.csidata.com/HolidayConfirmationsRequest Example
https://apps.csidata.com/HolidayConfirmationsResponse Example
Gann History
Produces a Gann series.
Request
- 
            csinumrequired integerThe csinum identifier. 
- 
            deliverymonthrequired integerThe request delivery month. 
- 
            monthsprioroptional integerThe number of months prior used. 
- 
            dayofmonthoptional integerThe day of month to use for rolling. 
- 
            showtotalsoptional booleanFlag to show total volume and open interest. 
- 
            showcashoptional booleanFlag to include cash series. 
- 
            includeweekendsoptional booleanFlag to include weekends. 
- 
            includeholidaysoptional booleanFlag to include holidays. 
- 
            startdateoptional dateStart date for the history returned in YYYYMMDD format. 
Response
- 
            DatedateThe date in YYYYMMDD format. 
- 
            DYDMintegerThe contract delivery year and month in YYYYMM format. 
- 
            OpendecimalThe open price. 
- 
            HighdecimalThe high price. 
- 
            LowdecimalThe low price. 
- 
            ClosedecimalThe close price. 
- 
            VolumedecimalThe volume. 
- 
            OpenInterestdecimalThe open interest. 
API Endpoint
https://apps.csidata.com/GannHistoryRequest Example
https://apps.csidata.com/GannHistory?csinum=2&monthsprior=0&dayofmonth=1&deliverymonth=12&format=csvResponse Example
Correlations OvO
Returns correlation coefficients and final zscore difference for one csinum against another ("One Vs One").
Request
- 
            Typerequired stringProvide "OvO" for one vs one. 
- 
            TimePeriodrequired signed integerThe time period used in the calculations. Possible values are: -3 3 Months -6 6 Months 1 1 Year 2 2 Years 5 5 Years 10 10 Years 15 15 Years 20 20 Years 25 25 Years 30 30 Years 35 35 Years 40 40 Years 
- 
            Csinum1required integerThe first csinum (stock or future). 
- 
            Csinum2required integerThe second csinum (stock or future). 
Response
- 
            PearsonLinearCorrelationdouble
- 
            SpearmanRankCorrelationdouble
- 
            FinalZScoreDiffdoubleThe Z Score Difference for the most recent day of data. 
API Endpoint
https://apps.csidata.com/CorrelationsRequest Example
https://apps.csidata.com/Correlations?Type=OvO&TimePeriod=5&Csinum1=2&Csinum2=8Response Example
Correlations MvM
Returns correlation coefficients and final zscore difference for a list of csinums ("Many Vs Many").
Request
- 
            Typerequired stringProvide "MvM" for many vs many. 
- 
            TimePeriodrequired signed integerThe time period used in the calculations. Possible values are: -3 3 Months -6 6 Months 1 1 Year 2 2 Years 5 5 Years 10 10 Years 15 15 Years 20 20 Years 25 25 Years 30 30 Years 35 35 Years 40 40 Years 
- 
            CsinumListrequired ListThe list of csinums seperated by commas (stocks and/or futures). 
Response
- 
            Csinum1integerThe first csinum. 
- 
            Csinum2integerThe second csinum. 
- 
            PearsonLinearCorrelationdouble
- 
            SpearmanRankCorrelationdouble
- 
            FinalZScoreDiffdoubleThe Z Score Difference for the most recent day of data. 
API Endpoint
https://apps.csidata.com/CorrelationsRequest Example
https://apps.csidata.com/Correlations?Type=MvM&TimePeriod=5&CsinumList=2,8,517Response Example
Correlations OvA
Returns correlation coefficients and final zscore difference for one csinum vs all others ("One Vs All").
Request
- 
            Typerequired stringProvide "OvA" for one vs all. 
- 
            TimePeriodrequired signed integerThe time period used in the calculations. Possible values are: -3 3 Months -6 6 Months 1 1 Year 2 2 Years 5 5 Years 10 10 Years 15 15 Years 20 20 Years 25 25 Years 30 30 Years 35 35 Years 40 40 Years 
- 
            Csinumrequired integerThe csinum. 
- 
            StockFutureComborequired integerThe group of markets to correlate against. 1 for stocks, 2 for futures, 3 for both 
- 
            MaxResultsToReturnoptional integerThe maximum results to return. Default is 10000. 
- 
            MinCorrFilteroptional doubleAll returned values will have pearson linear correlation bigger than this limit. Must be between 0 and 1. 
- 
            MaxCorrFilteroptional doubleAll returned values will have pearson linear correlation less than this limit. Must be between 0 and 1. 
- 
            MinZFilteroptional doubleAll returned values will have z score differences bigger than this limit. 
- 
            MaxZFilteroptional doubleAll returned values will have z score differences less than this limit. 
- 
            IncludePositiveNegativeCorroptional integerFlag to designate if the return values should include negative, positive, or both correlations (pearson). 
- 
            IncludePositiveNegativeZoptional integerFlag to designate if the return values should include negative, postive, or both z score differences. 
Response
- 
            CsinumintegerThe other csinum. 
- 
            PearsonLinearCorrelationdouble
- 
            SpearmanRankCorrelationdouble
- 
            FinalZScoreDiffdoubleThe Z Score Difference for the most recent day of data. 
API Endpoint
https://apps.csidata.com/CorrelationsRequest Example
https://apps.csidata.com/Correlations?Type=OvA&TimePeriod=5&Csinum=2&StockFutureCombo=3&MinCorrFilter=0&MaxCorrFilter=1&MinZFilter=0&MaxZFilter=20&MaxResultsToReturn=1000&IncludePositiveNegativeCorr=3&IncludePositiveNegativeZ=3Response Example
Top Correlated Stocks
Returns the most correlated stocks ordered by the Pearson linear correlation.
Request
- 
            TimePeriodrequired signed integerThe time period used in the calculations. Possible values are: -3 3 Months -6 6 Months 1 1 Year 2 2 Years 5 5 Years 10 10 Years 15 15 Years 20 20 Years 25 25 Years 30 30 Years 35 35 Years 40 40 Years 
- 
            Exchangesrequired stringA comma seperated list of stock exchange codes. 
- 
            Attachmentoptional booleanUse Attachment=1 to return the file as an attachment. 
Response
- 
            Csinum1integerThe csinum for the first stock. 
- 
            Symbol1stringThe symbol for the first stock. 
- 
            Exchange1stringThe exchange for the first stock. 
- 
            Csinum2integerThe csinum for the second stock. 
- 
            Symbol2stringThe symbol for the second stock. 
- 
            Exchange2stringThe exchange for the second stock. 
- 
            PearsonLinearCorrelationdouble
- 
            SpearmanRankCorrelationdouble
