Tech Document (Word Format)

22
Technology FAQs (continued) How do I retrieve S&P Capital IQ data with API functions? Before coding, it is important to understand S&P Capital IQ data and how API Functions are used to retrieve the data. Each category of data (e.g., Company Specific Data and Company Fundamental (Financials) Data) includes various Mnemonics (i.e., data item names) pertaining to each specific data item, which can be queried using the Functions provided within the API. Some functions return a single data value (point-in-time), while others return a series of data values. A description of each of the applicable Functions follows this section. Typical input parameters for the Functions include a single Company Identifier or list of Company Identifiers (e.g., Capital IQ IDs and Ticker Symbols), a single Mnemonic or a list of Mnemonics, and various other required and/or optional arguments referred to as Properties within the API. The required and/or optional Properties vary based on the Function used and Mnemonic requested. Each Function requires at least one Identifier. Identifiers are case sensitive and must be passed as uppercase. Identifier types can be mixed (i.e., IQ#### & TICKER). Each Function requires at least one Mnemonic. Mnemonics are case sensitive and must be passed as uppercase. A complete listing of Mnemonics available for this challenge is available in the appendix. Properties (i.e., Function Arguments) are passed as Key/Value pairs. A Complete listing of applicable Properties available for this challenge are available below. What are the available API Functions? Following is a description of each of the Functions that can be used to retrieve the S&P Capital IQ data for this challenge. GDSP This Function retrieves a single data value for a point-in-time for given Mnemonic(s). The default point-in-time for GDSP Function is Current, but can be changed if the GDSP Function is called with a startDate Property defined. Example (GDSP with 2 Identifers, 2 Mnemonics & 1 optional Property): S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-njit.com 1

Transcript of Tech Document (Word Format)

Page 1: Tech Document (Word Format)

Technology FAQs (continued)

How do I retrieve S&P Capital IQ data with API functions?

Before coding, it is important to understand S&P Capital IQ data and how API Functions are used to retrieve the data.

Each category of data (e.g., Company Specific Data and Company Fundamental (Financials) Data) includes various Mnemonics (i.e., data item names) pertaining to each specific data item, which can be queried using the Functions provided within the API. Some functions return a single data value (point-in-time), while others return a series of data values. A description of each of the applicable Functions follows this section.

Typical input parameters for the Functions include a single Company Identifier or list of Company Identifiers (e.g., Capital IQ IDs and Ticker Symbols), a single Mnemonic or a list of Mnemonics, and various other required and/or optional arguments referred to as Properties within the API. The required and/or optional Properties vary based on the Function used and Mnemonic requested.

Each Function requires at least one Identifier. Identifiers are case sensitive and must be passed as uppercase. Identifier types can be mixed (i.e., IQ#### & TICKER).

Each Function requires at least one Mnemonic. Mnemonics are case sensitive and must be passed as uppercase. A complete listing of Mnemonics available for this challenge is available in the appendix.

Properties (i.e., Function Arguments) are passed as Key/Value pairs. A Complete listing of applicable Properties available for this challenge are available below.

What are the available API Functions?

Following is a description of each of the Functions that can be used to retrieve the S&P Capital IQ data for this challenge.

GDSPThis Function retrieves a single data value for a point-in-time for given Mnemonic(s). The default point-in-time for GDSP Function is Current, but can be changed if the GDSP Function is called with a startDate Property defined.

Example (GDSP with 2 Identifers, 2 Mnemonics & 1 optional Property):GDSP | “IQ139488”, “IBM” | “IQ_COMPANY_NAME”, “IQ_TOTAL_REV” | “startDate” : “05/01/2014”

GDSHEThis Function retrieves a range of values for Mnemonic(s) by Rank or Date. Data values are returned according to the ’Rank’ or ‘Date’ Properties defined and results are ordered by ‘Rank’ or ‘Date’ value.

Example (GDSHE with 1 Identifer, 1 Mnemonics, 1 required (startRank) & 1 Optional (endRank) Property):GDSHE | “IQ139488” | “IQ_QUICK_COMP” | “startRank” : “1”,  “endRank” : “5”

Note: Some ‘Rank’ Mnemonics have upper range limits (for results) such as 5 or 10 depending on the Mnemonic.

Following is a list of the specialized request Properties by Function that can be used with specific Mnemonics (where ‘O’ is optional & ‘R’ is required):

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

1

Page 2: Tech Document (Word Format)

Property Keys GDSP GDSHE

startDate * O R

endDate O

startRank * R

endRank O

periodType ** O

filingMode ** O

restatementTypeId ** O

currencyId ** O

currencyConversionModeId ** O

*            For GDSHE, ‘startDate’ or ‘startRank’ is required**          For Company Fundamentals (financial period aligned data) Mnemonics

Descriptions of specialized request Properties:

Property Key Property Value Descriptions

startDate & endDate The valid values for startDate and endDate are valid dates (as MM/DD/YYYY).

startRank & endRank The valid values for startRank and endRank are 1 thru #.

PeriodType The following periodTypes can be used in the S&P Capital IQ API to specify the type of data being returned.

Relative: For retrieving data relative to a current period the functions accepts

IQ_FY: Fiscal YearIQ_CY: Calendar YearIQ_FQ: Fiscal QuarterIQ_CQ: Calendar QuarterIQ_LTM: Last 12 Months [default- Financials]IQ_NTM: Next 12 Months [default -Estimates]IQ_YTD: Year-to-Date

Any of the above period types can be used with an offset (+/- #) in order to retrieve historical or future periods.

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

2

Page 3: Tech Document (Word Format)

Absolute: For retrieving data within a specific fiscal date range the functions accepts the following as absolute period inputs

FYyyyy: Fiscal YearCYyyyy: Calendar YearFQqyyyy: Fiscal QuarterCQqyyyy: Calendar Quarter

Where yyyy is Year and q is Quarter (example: FQ32014 will return 3rd Quarter for fiscal Year 2014 data)

currencyID The currency in which the financial data should be displayed. Monetary data will be converted to this currency, if collected in a different currency. There are approximately 200 currencyId values  (example: LOCAL, USD, GBP, JPY, INR, etc.)

currencyConversionModeId If the currency is not the reported currency, this parameter controls how the data should be currency converted. The valid values for currencyConversionModeId are Historical or SpotRate.

restatementTypeId The valid values for restatementTypeId are:

O – Original versionP – Preliminary VersionLFR – Latest fully reported version [default]LRI – Latest reported instanceLRP – Latest reported periodLA – LatestIPO

filingMode The valid values for filingMode are:

P - Period [default]F - FilingE - Effective

Sample Company Data Mnemonics:

IQ_COMPANY_NAME Company NameIQ_COMPANY_TICKER Company TickerIQ_MARKETCAP Market CapitalizationIQ_SHARESOUTSTANDING Shares Outstanding

Sample Company Fiscal Period Aligned Data Mnemonics

IQ_TOTAL_REV RevenueIQ_NI Net IncomeIQ_PE_EXCL P/E (Diluted/Before Extraordinary)IQ_PE_NORMALIZED P/E (Normalized)IQ_PBV P/BIQ_PRICE_SALES P/S

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

3

Page 4: Tech Document (Word Format)

IQ_TEV_EBITDA EV/EBITDAIQ_TEV_TOTAL_REV EV/Revenue IQ_GROSS_MARGIN Gross MarginIQ_EARNING_CO_MARGIN Operating MarginIQ_NI_MARGIN Net MarginIQ_NI_NORM_MARGIN Net Margin (Normalized)IQ_RETURN_ASSETS Return On AssetsIQ_RETURN_EQUITY Return On EquityIQ_RETURN_CAPITAL Return On CapitalIQ_FIXED_ASSET_TURNS Asset Turnover

How do I use the .NET and Java API Client Libraries?

Client Library Response Types: OBJECT, JSON and XML

Query responses are returned in native OBJET format by default, which returns a List of SDKDataOutput objects that can be interrogated for the response data. To get results in XML or JSON format, simply make the request using the optional second argument as shown below:

JSON

String response Json = (String)serviceImpl.invokeDataService(input_request,”JSON”);

XML

String responseXml = (String)service.Impl.invokeDataService(input_request,”XML”);

A list of sample requests is available in the appendix.

What are the meanings of the common error responses?

It is possible to receive the following error responses when submitting a request:

Data Unavailable

This means that there is no coverage for the data request (the identifier, mnemonic, and function are correct for input).

Not Applicable

This means that an invalid identifier has been submitted that doesn’t match up with any of our identifier formats (at the entity or security level). It could mean you have used an entity level identifier as an input, but made a request for a security level mnemonic (or vice versa).

Invalid Identifier

This means that an invalid identifier was passed into a data request.

Invalid Mnemonic

This means that an incorrect mnemonic was passed into a data request.

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

4

Page 5: Tech Document (Word Format)

Input Arguments Missing

This means that there is one or more input arguments missing.

Function Mismatch

This means that a mnemonic has been passed in that does not work with the specific function it was assigned to (it works with another function).

Not Entitled

This means that the user is not entitled to the specific mnemonic passed in to the data request.

Error Processing Function / Error Processing Request / Invalid Request

These are general errors meaning there is an issue with the input parameters in the request – an input parameter might be missing or some of the input parameters may be invalid.

A full list of error responses is available in the appendix.

What are some API-specific best practices?

You should follow these practices when using the S&P Capital IQ API with the API Client Libraries or the JSON Direct (JSON/REST) access method.

Caching Data (Locally)

Caching data locally improves overall performance. If your application uses the same data point(s) frequently and you do not need to refresh data via the API every time, caching locally avoids the overhead of redundant requests. Additionally, if your workflow requires historical data points, local caching is highly recommended, as most historical data is static.

Validate API Inputs

Validate all API request input parameters (i.e. functions, identifiers, mnemonics, and property key/value pairs) prior to making any API request. This avoids the most common API errors.

Avoid Duplicate API Requests

When an API request is in progress, wait for the API response before making the same request. Multiple requests for the same identifier/mnemonic combinations can cause temporary blocking of API request processing leading to delays in API responses.

Multiple API Requests

Although concurrent API requests per IP address are supported, we advise limiting the number of concurrent API request threads to 5. Too many concurrent requests can cause processing time delays and, depending on your subscription, may even block API access.

API Request Sizes (Identifiers/Mnemonics per Request)

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

5

Page 6: Tech Document (Word Format)

It is good practice to group multiple functions, identifiers, and mnemonics in a single API request, although we recommend avoiding large requests. The API platform connection timeout is 15 minutes for a single API request.

When coding against the API, it’s helpful to size the number of data points being requested. We suggest tuning individual API requests to yield approximately 1000 data points, where each request is defined as one function, mnemonic, identifier (plus other property combinations as applicable).

Time Series, Historical, and Vector Information

The Time Series, Historical, and Vector functions (GDSHE) require more processing time and return more data points than the Point-in-Time functions (GDSP).

In addition to sizing the number of requests, when making requests for time series, historical, or vector API requests, limit the input ranges (data, rank, etc.) to return smaller API requests with better response times.

API Response Errors

It is good practice to resolve all known API errors. This avoids duplicate API requests with the same exception such as making multiple requests with an incorrect API user name and password, invalid inputs, etc.

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

6

Page 7: Tech Document (Word Format)

Appendix A: Mnemonics

Balance Sheet Statement MnemonicsCash And Equivalents IQ_CASH_EQUIVShort Term Investments IQ_ST_INVESTTotal Cash & ST Investments IQ_CASH_ST_INVESTAccounts Receivable IQ_ARTotal Receivables IQ_TOTAL_RECEIVInventory IQ_INVENTORYTotal Current Assets IQ_TOTAL_CAGross Property, Plant & Equipment IQ_GPPENet Property, Plant & Equipment IQ_NPPELong-term Investments IQ_LT_INVESTTotal Intangibles IQ_GW_INTANTotal Assets IQ_TOTAL_ASSETSAccounts Payable IQ_APShort-term Borrowings IQ_ST_DEBTCurrent Portion of Long Term Debt IQ_CURRENT_PORT_DEBTCurr. Port. of Cap. Leases IQ_CURRENT_PORT_LEASESTotal Current Liabilities IQ_TOTAL_CLLong-Term Debt IQ_LT_DEBTCapital Leases IQ_CAPITAL_LEASESMinority Interest IQ_MINORITY_INTERESTTotal Liabilities IQ_TOTAL_LIABTotal Pref. Equity IQ_PREF_EQUITYCommon Stock IQ_COMMONRetained Earnings IQ_RETreasury Stock IQ_TREASURYTotal Common Equity IQ_TOTAL_COMMON_EQUITYTotal Equity IQ_TOTAL_EQUITYTotal Liabilities And Equity IQ_TOTAL_LIAB_EQUITYFiling Date IQ_FILINGDATE_BSPeriod Date IQ_PERIODDATE_BSShares Outstanding on Filing Cover IQ_OUTSTANDING_FILING_DATEShares Outstanding on Balance Sheet Date IQ_OUTSTANDING_BS_DATETotal Shares Out. On Filing Date IQ_TOTAL_OUTSTANDING_FILING_DATETotal Shares Outstanding on BS Date IQ_TOTAL_OUTSTANDING_BS_DATEBook Value/Share IQ_BV_SHARETangible Book Value IQ_TBVTangible Book Value/Share IQ_TBV_SHARETotal Debt IQ_TOTAL_DEBT

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

7

Page 8: Tech Document (Word Format)

Total Current Debt IQ_TOTAL_DEBT_CURRENTTotal Non-Current Debt IQ_TOTAL_DEBT_NON_CURRENTNet Debt IQ_NET_DEBTTotal Capitalization IQ_TOTAL_CAPFull Time Employees IQ_FULL_TIMEIncome Statement MnemonicsTotal Revenues IQ_TOTAL_REVCost Of Revenues IQ_COST_REVCost Of Goods Sold IQ_COGSGross Profit IQ_GPSelling General & Admin Exp. IQ_SGA_SUPPLR & D Exp. IQ_RD_EXPDepreciation & Amort. IQ_DA_SUPPLAmort. of Goodwill and Intangibles IQ_GW_INTAN_AMORTOperating Income IQ_OPER_INCNet Interest Exp. IQ_NET_INTEREST_EXPEBT Excl Unusual Items IQ_EBT_EXCLTotal Unusual Items IQ_TOTAL_UNUSUALEBT Incl Unusual Items IQ_EBTIncome Tax Expense IQ_INC_TAXEarnings from Cont. Ops. IQ_EARNING_COEarnings of Discontinued Ops. IQ_DOExtraord. Item & Account. Change IQ_EXTRA_ACC_ITEMSNet Income IQ_NIPref. Dividends and Other Adj. IQ_PREF_DIV_OTHERMerger/Restructuring Costs IQ_MERGER_RESTRUCTURENI to Common Incl Extra Items IQ_NI_AVAIL_INCLNI to Common Excl Extra Items IQ_NI_AVAIL_EXCLBasic EPS IQ_BASIC_EPS_INCLBasic EPS Excl. Extra Items IQ_BASIC_EPS_EXCLWeighted Avg. Basic Shares Out. IQ_BASIC_WEIGHTDiluted EPS IQ_DILUT_EPS_INCLDiluted EPS Excl Extra Itmes IQ_DILUT_EPS_EXCLWeighted Avg. Diluted Shares Out. IQ_DILUT_WEIGHTNormalized Basic EPS IQ_EPS_NORMNormalized Diluted EPS IQ_DILUT_EPS_NORMEBITDA IQ_EBITDAEBITDA (Incl. Equity Inc. from Affiliates) IQ_EBITDA_EQ_INCEBITA IQ_EBITAEBIT IQ_EBITEBITDAR IQ_EBITDARNet Rental Expense IQ_NET_RENTAL_EXP_FN

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

8

Page 9: Tech Document (Word Format)

Normalized Net Income IQ_NI_NORMSame Store Sales Growth % IQ_SAME_STOREEffective Tax Rate IQ_EFFECT_TAX_RATEPayout Ratio IQ_PAYOUT_RATIOInterest On Long Term Debt IQ_INT_EXP_LTDTotal Current Taxes IQ_CURR_TAXESTotal Deferred Taxes IQ_DEFERRED_TAXES_TOTALCash Flow Statement MnemonicsNet Income IQ_NI_CFDepreciation & Amort., Total IQ_DA_CFAsset Writedown & Restructuring IQ_ASSET_WRITEDOWN_CFCosts Stock-Based Compensation IQ_STOCK_BASED_CFNet Cash From Discontinued Ops. IQ_DO_CFChange In Accounts Receivable IQ_CHANGE_ARChange In Inventories IQ_CHANGE_INVENTORYChange in Acc. Payable IQ_CHANGE_APChange in Unearned Rev. IQ_CHANGE_UNEARN_REVChange in Inc. Taxes IQ_CHANGE_INC_TAXChange in Def. Taxes IQ_CHANGE_DEF_TAXCash from Ops. IQ_CASH_OPERCapital Expenditure IQ_CAPEXSale of Property, Plant, and Equipment IQ_SALE_PPE_CFCash Acquisitions IQ_CASH_ACQUIRE_CFDivestitures IQ_DIVEST_CFSale (Purchase) of Intangible assets IQ_SALE_INTAN_CFNet Cash from Investments IQ_INVEST_SECURITY_CFCash from Investing IQ_CASH_INVESTShort Term Debt Issued IQ_ST_DEBT_ISSUEDLong-Term Debt Issued IQ_LT_DEBT_ISSUEDTotal Debt Issued IQ_TOTAL_DEBT_ISSUEDShort Term Debt Repaid IQ_ST_DEBT_REPAIDLong-Term Debt Repaid IQ_LT_DEBT_REPAIDTotal Debt Repaid IQ_TOTAL_DEBT_REPAIDIssuance of Common Stock IQ_COMMON_ISSUEDRepurchase of Common IQ_COMMON_REPIssuance of Preferred Stock IQ_PREF_ISSUEDRepurchase of Preferred IQ_PREF_REPCommon Dividends Paid IQ_COMMON_DIV_CFPref. Dividends Paid IQ_PREF_DIV_CFCommon and/or Pref. Dividends Paid IQ_COMMON_PREF_DIV_CF

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

9

Page 10: Tech Document (Word Format)

Total Dividends Paid IQ_TOTAL_DIV_PAID_CFCash from Financing IQ_CASH_FINANNet Change in Cash IQ_NET_CHANGECash Interest Paid IQ_CASH_INTERESTCash Taxes Paid IQ_CASH_TAXESNet Debt Issued IQ_NET_DEBT_ISSUEDLevered Free Cash Flow IQ_LEVERED_FCFUnlevered Free Cash Flow IQ_UNLEVERED_FCFChange in Net Working Capita IQ_CHANGE_NET_WORKING_CAPITALEBITDA - Capex IQ_EBITDA_CAPEXRatios MnemonicsReturn on Assets % IQ_RETURN_ASSETSReturn on Equity % IQ_RETURN_EQUITYGross Margin % IQ_GROSS_MARGINSG&A Margin % IQ_SGA_MARGINEBITDA Margin % IQ_EBITDA_MARGINNet Income Margin % IQ_NI_MARGINLevered Free Cash Flow Margin % IQ_LFCF_MARGINAccounts Receivable Turnover IQ_AR_TURNSInventory Turnover IQ_INVENTORY_TURNSCurrent Ratio IQ_CURRENT_RATIOQuick Ratio IQ_QUICK_RATIOAvg Days Sales Outstanding IQ_DAYS_SALES_OUTAvg Days Payable Outstanding IQ_DAYS_PAYABLE_OUTTotal Debt/Equity IQ_TOTAL_DEBT_EQUITYTotal Debt/Capital IQ_TOTAL_DEBT_CAPITALEBIT / Interest Expense IQ_EBIT_INTCapex as % of Revenues IQ_CAPEX_PCT_REVTotal Debt/EBITDA IQ_TOTAL_DEBT_EBITDANet Debt/EBITDA IQ_NET_DEBT_EBITDAReturn on Capital % IQ_RETURN_CAPITALMarket Data MnemonicsPricing Date IQ_PRICEDATEStock Exchange IQ_EXCHANGELast Sale Price IQ_LASTSALEPRICEClose Price IQ_CLOSEPRICEDividend Adjusted Day Close Price IQ_CLOSEPRICE_ADJVolume Weighted Average Price IQ_VWAP52 Week High Price IQ_YEARHIGH52 Week High Date IQ_YEARHIGH_DATE

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

10

Page 11: Tech Document (Word Format)

Daily Volume IQ_VOLUMEDaily Value Traded IQ_VALUE_TRADEDMarket Capitalization IQ_MARKETCAPEnterprise Value IQ_TEVShares Outstanding IQ_SHARESOUTSTANDING5 Year Beta IQ_BETA_5YR5 Year Price Volatility IQ_PRICE_VOL_HIST_5YRFund NAV IQ_FUND_NAVDividend Yield IQ_DIVIDEND_YIELDLatest Annualized Dividend Per Share IQ_ANNUALIZED_DIVIDENDGrowth (Up to 10 years of growth) MnemonicsTotal Revenues, 1 Yr Growth % IQ_TOTAL_REV_1YR_ANN_GROWTHGross Profit, 1 Yr Growth % IQ_GP_1YR_ANN_GROWTHEBITDA, 1 Yr Growth % IQ_EBITDA_1YR_ANN_GROWTHEBIT, 1 Yr Growth % IQ_EBIT_1YR_ANN_GROWTHNet Income, 1 Yr Growth % IQ_NI_1YR_ANN_GROWTHNormalized Net Income, 1 Yr Growth % IQ_NI_NORM_1YR_ANN_GROWTHDiluted EPS before Extra, 1 Yr Growth % IQ_EPS_1YR_ANN_GROWTHCommon Equity, 1 Yr Growth % IQ_COMMON_EQUITY_1YR_ANN_GROWTHInventory, 1 Yr Growth % IQ_INV_1YR_ANN_GROWTHTotal Assets, 1 Yr Growth % IQ_TOTAL_ASSETS_1YR_ANN_GROWTHTangible Book Value, 1 Yr Growth % IQ_TBV_1YR_ANN_GROWTHCash from Operations, 1 Yr Growth % IQ_CFO_1YR_ANN_GROWTHCapital Expenditures, 1 Yr Growth % IQ_CAPEX_1YR_ANN_GROWTHLevered Free Cash Flow, 1 Yr Growth % IQ_LFCF_1YR_ANN_GROWTHUnlevered Free Cash Flow, 1 Yr Growth % IQ_UFCF_1YR_ANN_GROWTHDividend per Share, 1 Yr Growth % IQ_DPS_1YR_ANN_GROWTHValuation MnemonicsTEV/Total Revenues IQ_TEV_TOTAL_REVTEV/EBITDA IQ_TEV_EBITDATEV/EBIT IQ_TEV_EBITTEV/Unlevered FCF IQ_TEV_UFCFMarket Cap/Levered FCF IQ_MARKET_CAP_LFCFP/Diluted EPS before extra IQ_PE_EXCLP/BV IQ_PBVP/TangBV IQ_PTBVP/Sales IQ_PRICE_SALESTEV/Forward Total Revenue IQ_TEV_TOTAL_REV_FWDTEV/Forward EBITDA IQ_TEV_EBITDA_FWDTEV/Forward EBIT IQ_TEV_EBIT_FWD

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

11

Page 12: Tech Document (Word Format)

P/Forward Diluted EPS before extra IQ_PE_EXCL_FWDPEG Ratio IQ_PEG_FWDP/Forward CFPS IQ_PRICE_CFPS_FWDCompany Information & Ownership MnemonicsCompany Name IQ_COMPANY_NAMECIQ Company ID IQ_COMPANY_IDBusiness Description IQ_BUSINESS_DESCRIPTIONHeadquarters IQ_COMPANY_ADDRESSPrimary Industry IQ_PRIMARY_INDUSTRYNumber of Shareholders IQ_NUMBER_SHAREHOLDERSInstitutional Owner IQ_INSTITUTIONAL_OWNERInstitutional Owner Total Shares IQ_INSTITUTIONAL_SHARESInsider Owner IQ_INSIDER_OWNERInsider Owner Total Shares IQ_INSIDER_SHARESHolder Name IQ_HOLDER_NAMEHolder CIQ ID IQ_HOLDER_CIQIDHolder Total Shares IQ_HOLDER_SHARESMutual Fund Name IQ_HOLDER_FUND_NAMEMutual Fund Shares Held IQ_HOLDER_FUND_SHARESMutual Fund % of Shares Outstanding IQ_HOLDER_FUND_PERCENT

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

12

Page 13: Tech Document (Word Format)

Appendix B: Sample API RequestsREQUEST 1 - Company Lookup (by Name) to get the CIQ Company ID -----------------------------------------------------------------------

Function : GDSHEIdentifiers : MCDONALDSMnemonics : IQ_COMPANY_NAME_QUICK_MATCH, IQ_COMPANY_ID_QUICK_MATCHProperties[1] : startRank = 1Properties[2] : endRank = 5

REQUEST 1 RESULTS - List of Company Names & IDs (by rank)-----------------------------------------------------------------------

1 | McDonald's Corp.2 | McDonald's Holdings Company (Japan), Ltd.3 | McDonald's Restaurants Limited4 | Happy Family Foods Ltd.5 | Mcdonaldís Co. (Japan) Ltd.-- 1 | IQ1394882 | IQ65618113 | IQ54726994 | IQ1085453535 | IQ31271459

REQUEST 1 - Sample using API JSON Direct request method (JSON Request Format for HTTP POST body)

... API REST URL: https://sdk.gds.standardandpoors.com/gdssdk/rest/v2/clientservice.json-----------------------------------------------------------------------

inputRequests= {inputRequests: [{function:"GDSHE",identifier:"MCDONALDS",mnemonic:"IQ_COMPANY_NAME_QUICK_MATCH",properties:{startRank:"1",endRank:"5"}},{function:"GDSHE",identifier:"MCDONALDS",mnemonic:"IQ_COMPANY_ID_QUICK_MATCH",properties:{startRank:"1",endRank:"5"}} ] }

REQUEST 1 RESULTS - List of Company Names & IDs (by rank)-----------------------------------------------------------------------1 | McDonald's Corp.2 | McDonald's Holdings Company (Japan), Ltd.3 | McDonald's Restaurants Limited4 | Happy Family Foods Ltd.5 | Mcdonaldís Co. (Japan) Ltd.-- 1 | IQ139488

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

13

Page 14: Tech Document (Word Format)

2 | IQ65618113 | IQ54726994 | IQ1085453535 | IQ31271459

REQUEST 2 - Company Comps (by ID) to get Top 10 Comp Companies -----------------------------------------------------------------------

Function : GDSHEIdentifiers : IQ139488Mnemonics : IQ_QUICK_COMPProperties[1] : startRank = 1Properties[2] : endRank = 10

REQUEST 2 RESULTS - List of Top 10 Comp Companies Ticker IDs (by rank)-----------------------------------------------------------------------1 | NYSE:YUM2 | NYSE:CMG3 | NasdaqGS:SBUX4 | LSE:CPG5 | NasdaqGS:WEN6 | NasdaqGS:JACK7 | NYSE:BKW8 | NYSE:DRI9 | NasdaqGS:DNKN10| NasdaqGS:RRG

REQUEST 3 - Company Info & Financials (by IDs with Period/Date referencing)

... latest 2 fiscal Annual periods (via periodType property)

... latest 4 fiscal Quarterly periods (via periodType property)

... latest # days Daily market prices (via startDate property) -----------------------------------------------------------------------

Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_COMPANY_NAME, IQ_COMPANY_TICKER, IQ_MARKETCAP, IQ_SHARESOUTSTANDING-------------Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_TOTAL_REV, IQ_NI Properties[1] : periodType = IQ_FYProperties[2] : restatementTypeId = LFRProperties[3] : filingMode = PProperties[4] : currencyId = USDProperties[5] : currencyConversionModeId = Historical-------------

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

14

Page 15: Tech Document (Word Format)

Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_TOTAL_REV, IQ_NI Properties[1] : periodType = IQ_FY-1Properties[2] : restatementTypeId = LFRProperties[3] : filingMode = PProperties[4] : currencyId = USDProperties[5] : currencyConversionModeId = Historical-------------Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_TOTAL_REV, IQ_NI Properties[1] : periodType = IQ_FQProperties[2] : restatementTypeId = LFRProperties[3] : filingMode = PProperties[4] : currencyId = USDProperties[5] : currencyConversionModeId = Historical-------------Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_TOTAL_REV, IQ_NIProperties[1] : periodType = IQ_FQ-1Properties[2] : restatementTypeId = LFRProperties[3] : filingMode = PProperties[4] : currencyId = USDProperties[5] : currencyConversionModeId = Historical-------------Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_TOTAL_REV, IQ_NIProperties[1] : periodType = IQ_FQ-2Properties[2] : restatementTypeId = LFRProperties[3] : filingMode = PProperties[4] : currencyId = USDProperties[5] : currencyConversionModeId = Historical-------------Function : GDSPIdentifiers : IQ139488Mnemonics : IQ_TOTAL_REV, IQ_NIProperties[1] : periodType = IQ_FQ-3Properties[2] : restatementTypeId = LFRProperties[3] : filingMode = PProperties[4] : currencyId = USDProperties[5] : currencyConversionModeId = Historical-------------Function : GDSHEIdentifiers : IQ139488Mnemonics : IQ_CLOSEPRICE Properties[1] : startDate = 09/01/2014Properties[2] : currencyId = USDProperties[3] : currencyConversionModeId = Historical

REQUEST 3 RESULTS - Company Specific (Current) Period Specific Financials Market Data (Daily)

-----------------------------------------------------------------------

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

15

Page 16: Tech Document (Word Format)

current | IQ_COMPANY_NAME | McDonald's Corp.current | IQ_COMPANY_TICKER | NYSE:MCDcurrent | IQ_MARKETCAP | 91123.011200current | IQ_SHARESOUTSTANDING | 981.929000IQ_FY | IQ_TOTAL_REV | 28105.700000IQ_FY | IQ_NI | 5585.900000IQ_FY-1 | IQ_TOTAL_REV | 27567.000000IQ_FY-1 | IQ_NI | 5464.800000IQ_FQ | IQ_TOTAL_REV | 7181.700000IQ_FQ | IQ_NI | 1387.100000IQ_FQ-1 | IQ_TOTAL_REV | 6700.300000IQ_FQ-1 | IQ_NI | 1204.800000IQ_FQ-2 | IQ_TOTAL_REV | 7093.200000IQ_FQ-2 | IQ_NI | 1397.000000IQ_FQ-3 | IQ_TOTAL_REV | 7323.400000IQ_FQ-3 | IQ_NI | 1522.20000009/02/2014 | IQ_CLOSEPRICE | 92.80000009/03/2014 | IQ_CLOSEPRICE | 93.14000009/04/2014 | IQ_CLOSEPRICE | 93.010000

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

16

Page 17: Tech Document (Word Format)

Appendix C: Error ResponsesAPI Error Message Readable FormatAGGREGATEREQUESTTOOLARGE Aggregate Request Too LargeANALYSTNAMENOTREPORTED Analyst Name Not ReportedANALYSTNOTPROFILED Analyst Not Profiled

CANNOTDISPLAYLISTSWITHOVER10000CONSTITUENTSCannot Display Lists With Over 10,000 Constituents

CAPABILITYNEEDED Capability NeededCURRENCYNOTAVAILABLE Currency Not AvailableDATACANNOTBEAGGREGATED Data Cannot Be AggregatedDATA UNAVAILABLE Data UnavailableDETAILEDDATAUNAVAILABLE Detailed Data UnavailableENTITLEMENTNEEDED Entitlement Needed

ERROR GETTING DATAError Getting Data - Please Try Again!

ERROR PROCESSING FUNCTIONError Processing Function - Please Try Again!

ERROR PROCESSING THE REQUESTError Processing the Reques! - (JSON Direct Input)

ESCAPE WORDS NOT ALLOWED Escape Words Not AllowedEXCEEDED THE RATE LIMIT Exceeded The Rate LimitEXCEEDS5YEARLIMIT Exceeds 5 Year LimitEXCEEDS8YEARLIMIT Exceeds 8 Year LimitFREQUENCY NOT APPLICABLE Frequency Not ApplicableFUNCTION MISMATCH Function MismatchGDS CURRENTLY UNAVAILABLE - PLEASE TRY AGAIN LATER

GDS Currently Unavailable - Please Try Again Later!

HISTORICALDATANOTAVAILABLEFORREQUESTEDLISTTYPE

Historical Data Not Available For Requested List Type

INPUT ARGUMENTS MISSING Input Arguments MissingINVALIDASOFDATE Invalid AsOfDateINVALIDCONTRIBUTOR Invalid ContributorINVALIDCOUNT Invalid CountINVALIDCURRENCY Invalid CurrencyINVALIDCURRENCYREQUEST Invalid Currency RequestINVALIDDATAVENDOR Invalid Data VendorINVALID DATE ARGUMENT Invalid Date ArgumentINVALID DATE ENTERED Invalid Date Entered

INVALID DATE RANGE FOR FREQUENCYInvalid Date Range For Frequency

INVALIDDISPLAY Invalid DisplayINVALIDENTRY Invalid EntryINVALIDFACTORCODE Invalid Factor CodeINVALID FISCAL DATE FORMAT Invalid Fiscal Date FormatINVALIDFORMULAMETRIC Invalid Formula MetricINVALID FREQUENCY Invalid FrequencyINVALID FUNCTION Invalid Function

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

17

Page 18: Tech Document (Word Format)

INVALID IDENTIFIER Invalid IdentifierINVALIDIDENTIFIER Invalid IdentifierINVALIDINDEX Invalid IndexINVALIDLISTID Invalid List IdentifierINVALIDMETRIC Invalid MetricINVALID MNEMONIC Invalid MnemonicINVALIDPARAMETERS Invalid ParametersINVALIDPERIODRANGE Invalid Period RangeINVALIDPERIODTYPE Invalid Period TypeINVALIDRATING Invalid RatingINVALIDRATINGCHARACTERISTIC Invalid Rating CharacteristicINVALIDRATINGOPTION Invalid Rating OptionINVALIDRATIO Invalid RatioINVALID REQUEST Invalid RequestINVALIDRESTATEMENTTYPE Invalid Restatement TypeINVALIDSECONDPARTY Invalid Second PartyINVALIDSECTOR Invalid SectorINVALID SENIORITY CODE Invalid Seniority CodeINVALID SNAP TYPE Invalid Snap TypeINVALIDSOLICITATION Invalid SolicitationINVALIDTENOR Invalid TenorINVALIDTIMEPERIOD Invalid Time PeriodINVALIDTRANSACTIONID Invalid Transaction IdentifierINVALIDWEIGHTTYPE Invalid Weight TypeNEWDATAAVAILABLE New Data AvailableNONE NoneNOT APPLICABLE Not ApplicableNOT ENTITLED Not EntitledNOTSUPPORTED Not SupportedNOTSUPPORTEDIDENTIFIER Not Supported IdentifierONLYCONSENSUSAVAILABLE Only Consensus AvailablePLEASE AUTHENTICATE Please Authenticate

REQUEST NOT PROCESSEDRequest Not Processed - Please Try Again!

REQUEST TIMED OUTRequest Timed Out - Please Try Again!

REQUESTTOOLARGE Request Too LargeSECONDPARTYINVALID Second Party InvalidSENIORITY CODE NOT APPLICABLE Seniority Code Not ApplicableSNAP TYPE NOT APPLICABLE Snap Type Not ApplicableSUBSCRIPTION LIMIT Subscription LimitTHE REMOTE SERVER RETURNED AN ERROR: (400) BAD REQUEST.

The Remote Server Returned An Error: (400) BAD REQUEST

THERE WAS AN ERROR PROCESSING YOUR REQUESTThere Was An Error Processing Your Request!

THEREWASANERRORPROCESSINGYOURREQUESTThere Was An Error Processing Your Request!

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

18

Page 19: Tech Document (Word Format)

TOOMANYLISTCONSTITUENTS Too Many List Constituents

UNEXPECTED ERROR - PLEASE TRY AGAIN LATERUnexpected Error - Please Try Again!

USERACCESSRESTRICTED User Access RestrictedUSERNAME FOR DESTINATION SYSTEM IS NOT MAPPED.

Username For Destination System Is Not Mapped

S&P Capital IQ Tablet Application Challenge, Fall 2014www.spcapitaliq-njit.com

19