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): GDSP | “IQ139488”, “IBM” | “IQ_COMPANY_NAME”, “IQ_TOTAL_REV” | “startDate” : “05/01/2014”
GDSHE This 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 2014 www.spcapitaliq-‐njit.com
1
Property Keys startDate *
GDSP
GDSHE
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 Year IQ_CY: Calendar Year IQ_FQ: Fiscal Quarter IQ_CQ: Calendar Quarter IQ_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 2014 www.spcapitaliq-‐njit.com
2
Absolute: For retrieving data within a specific fiscal date range the functions accepts the following as absolute period inputs FYyyyy: Fiscal Year CYyyyy: Calendar Year FQqyyyy: Fiscal Quarter CQqyyyy: Calendar Quarter Where yyyy is Year and q is Quarter rd (example: FQ32014 will return 3 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 version P – Preliminary Version LFR – Latest fully reported version [default] LRI – Latest reported instance LRP – Latest reported period LA – Latest IPO
filingMode
The valid values for filingMode are: P - Period [default] F - Filing E - Effective
Sample Company Data Mnemonics: IQ_COMPANY_NAME IQ_COMPANY_TICKER IQ_MARKETCAP IQ_SHARESOUTSTANDING
Company Name Company Ticker Market Capitalization Shares Outstanding
Sample Company Fiscal Period Aligned Data Mnemonics IQ_TOTAL_REV IQ_NI IQ_PE_EXCL IQ_PE_NORMALIZED IQ_PBV IQ_PRICE_SALES
Revenue Net Income P/E (Diluted/Before Extraordinary) P/E (Normalized) P/B P/S
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
3
IQ_TEV_EBITDA IQ_TEV_TOTAL_REV IQ_GROSS_MARGIN IQ_EARNING_CO_MARGIN IQ_NI_MARGIN IQ_NI_NORM_MARGIN IQ_RETURN_ASSETS IQ_RETURN_EQUITY IQ_RETURN_CAPITAL IQ_FIXED_ASSET_TURNS
EV/EBITDA EV/Revenue Gross Margin Operating Margin Net Margin Net Margin (Normalized) Return On Assets Return On Equity Return On Capital 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. Input Arguments Missing
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
4
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) 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
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
5
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 2014 www.spcapitaliq-‐njit.com
6
Appendix A: Mnemonics Balance Sheet Statement
Mnemonics
Cash And Equivalents
IQ_CASH_EQUIV
Short Term Investments
IQ_ST_INVEST
Total Cash & ST Investments
IQ_CASH_ST_INVEST
Accounts Receivable
IQ_AR
Total Receivables
IQ_TOTAL_RECEIV
Inventory
IQ_INVENTORY
Total Current Assets
IQ_TOTAL_CA
Gross Property, Plant & Equipment
IQ_GPPE
Net Property, Plant & Equipment
IQ_NPPE
Long-term Investments
IQ_LT_INVEST
Total Intangibles
IQ_GW_INTAN
Total Assets
IQ_TOTAL_ASSETS
Accounts Payable
IQ_AP
Short-term Borrowings
IQ_ST_DEBT
Current Portion of Long Term Debt
IQ_CURRENT_PORT_DEBT
Curr. Port. of Cap. Leases
IQ_CURRENT_PORT_LEASES
Total Current Liabilities
IQ_TOTAL_CL
Long-Term Debt
IQ_LT_DEBT
Capital Leases
IQ_CAPITAL_LEASES
Minority Interest
IQ_MINORITY_INTEREST
Total Liabilities
IQ_TOTAL_LIAB
Total Pref. Equity
IQ_PREF_EQUITY
Common Stock
IQ_COMMON
Retained Earnings
IQ_RE
Treasury Stock
IQ_TREASURY
Total Common Equity
IQ_TOTAL_COMMON_EQUITY
Total Equity
IQ_TOTAL_EQUITY
Total Liabilities And Equity
IQ_TOTAL_LIAB_EQUITY
Filing Date
IQ_FILINGDATE_BS
Period Date
IQ_PERIODDATE_BS
Shares Outstanding on Filing Cover
IQ_OUTSTANDING_FILING_DATE
Shares Outstanding on Balance Sheet Date
IQ_OUTSTANDING_BS_DATE
Total Shares Out. On Filing Date
IQ_TOTAL_OUTSTANDING_FILING_DATE
Total Shares Outstanding on BS Date
IQ_TOTAL_OUTSTANDING_BS_DATE
Book Value/Share
IQ_BV_SHARE
Tangible Book Value
IQ_TBV
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
7
Tangible Book Value/Share
IQ_TBV_SHARE
Total Debt
IQ_TOTAL_DEBT
Total Current Debt
IQ_TOTAL_DEBT_CURRENT
Total Non-Current Debt
IQ_TOTAL_DEBT_NON_CURRENT
Net Debt
IQ_NET_DEBT
Total Capitalization
IQ_TOTAL_CAP
Full Time Employees
IQ_FULL_TIME
Income Statement
Mnemonics
Total Revenues
IQ_TOTAL_REV
Cost Of Revenues
IQ_COST_REV
Cost Of Goods Sold
IQ_COGS
Gross Profit
IQ_GP
Selling General & Admin Exp.
IQ_SGA_SUPPL
R & D Exp.
IQ_RD_EXP
Depreciation & Amort.
IQ_DA_SUPPL
Amort. of Goodwill and Intangibles
IQ_GW_INTAN_AMORT
Operating Income
IQ_OPER_INC
Net Interest Exp.
IQ_NET_INTEREST_EXP
EBT Excl Unusual Items
IQ_EBT_EXCL
Total Unusual Items
IQ_TOTAL_UNUSUAL
EBT Incl Unusual Items
IQ_EBT
Income Tax Expense
IQ_INC_TAX
Earnings from Cont. Ops.
IQ_EARNING_CO
Earnings of Discontinued Ops.
IQ_DO
Extraord. Item & Account. Change
IQ_EXTRA_ACC_ITEMS
Net Income
IQ_NI
Pref. Dividends and Other Adj.
IQ_PREF_DIV_OTHER
Merger/Restructuring Costs
IQ_MERGER_RESTRUCTURE
NI to Common Incl Extra Items
IQ_NI_AVAIL_INCL
NI to Common Excl Extra Items
IQ_NI_AVAIL_EXCL
Basic EPS
IQ_BASIC_EPS_INCL
Basic EPS Excl. Extra Items
IQ_BASIC_EPS_EXCL
Weighted Avg. Basic Shares Out.
IQ_BASIC_WEIGHT
Diluted EPS
IQ_DILUT_EPS_INCL
Diluted EPS Excl Extra Itmes
IQ_DILUT_EPS_EXCL
Weighted Avg. Diluted Shares Out.
IQ_DILUT_WEIGHT
Normalized Basic EPS
IQ_EPS_NORM
Normalized Diluted EPS
IQ_DILUT_EPS_NORM
EBITDA
IQ_EBITDA
EBITDA (Incl. Equity Inc. from Affiliates)
IQ_EBITDA_EQ_INC
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
8
EBITA
IQ_EBITA
EBIT
IQ_EBIT
EBITDAR
IQ_EBITDAR
Net Rental Expense
IQ_NET_RENTAL_EXP_FN
Normalized Net Income
IQ_NI_NORM
Same Store Sales Growth %
IQ_SAME_STORE
Effective Tax Rate
IQ_EFFECT_TAX_RATE
Payout Ratio
IQ_PAYOUT_RATIO
Interest On Long Term Debt
IQ_INT_EXP_LTD
Total Current Taxes
IQ_CURR_TAXES
Total Deferred Taxes
IQ_DEFERRED_TAXES_TOTAL
Cash Flow Statement
Mnemonics
Net Income
IQ_NI_CF
Depreciation & Amort., Total
IQ_DA_CF
Asset Writedown & Restructuring
IQ_ASSET_WRITEDOWN_CF
Costs Stock-Based Compensation
IQ_STOCK_BASED_CF
Net Cash From Discontinued Ops.
IQ_DO_CF
Change In Accounts Receivable
IQ_CHANGE_AR
Change In Inventories
IQ_CHANGE_INVENTORY
Change in Acc. Payable
IQ_CHANGE_AP
Change in Unearned Rev.
IQ_CHANGE_UNEARN_REV
Change in Inc. Taxes
IQ_CHANGE_INC_TAX
Change in Def. Taxes
IQ_CHANGE_DEF_TAX
Cash from Ops.
IQ_CASH_OPER
Capital Expenditure
IQ_CAPEX
Sale of Property, Plant, and Equipment
IQ_SALE_PPE_CF
Cash Acquisitions
IQ_CASH_ACQUIRE_CF
Divestitures
IQ_DIVEST_CF
Sale (Purchase) of Intangible assets
IQ_SALE_INTAN_CF
Net Cash from Investments
IQ_INVEST_SECURITY_CF
Cash from Investing
IQ_CASH_INVEST
Short Term Debt Issued
IQ_ST_DEBT_ISSUED
Long-Term Debt Issued
IQ_LT_DEBT_ISSUED
Total Debt Issued
IQ_TOTAL_DEBT_ISSUED
Short Term Debt Repaid
IQ_ST_DEBT_REPAID
Long-Term Debt Repaid
IQ_LT_DEBT_REPAID
Total Debt Repaid
IQ_TOTAL_DEBT_REPAID
Issuance of Common Stock
IQ_COMMON_ISSUED
Repurchase of Common
IQ_COMMON_REP
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
9
Issuance of Preferred Stock
IQ_PREF_ISSUED
Repurchase of Preferred
IQ_PREF_REP
Common Dividends Paid
IQ_COMMON_DIV_CF
Pref. Dividends Paid
IQ_PREF_DIV_CF
Common and/or Pref. Dividends Paid
IQ_COMMON_PREF_DIV_CF
Total Dividends Paid
IQ_TOTAL_DIV_PAID_CF
Cash from Financing
IQ_CASH_FINAN
Net Change in Cash
IQ_NET_CHANGE
Cash Interest Paid
IQ_CASH_INTEREST
Cash Taxes Paid
IQ_CASH_TAXES
Net Debt Issued
IQ_NET_DEBT_ISSUED
Levered Free Cash Flow
IQ_LEVERED_FCF
Unlevered Free Cash Flow
IQ_UNLEVERED_FCF
Change in Net Working Capita
IQ_CHANGE_NET_WORKING_CAPITAL
EBITDA - Capex
IQ_EBITDA_CAPEX
Ratios
Mnemonics
Return on Assets %
IQ_RETURN_ASSETS
Return on Equity %
IQ_RETURN_EQUITY
Gross Margin %
IQ_GROSS_MARGIN
SG&A Margin %
IQ_SGA_MARGIN
EBITDA Margin %
IQ_EBITDA_MARGIN
Net Income Margin %
IQ_NI_MARGIN
Levered Free Cash Flow Margin %
IQ_LFCF_MARGIN
Accounts Receivable Turnover
IQ_AR_TURNS
Inventory Turnover
IQ_INVENTORY_TURNS
Current Ratio
IQ_CURRENT_RATIO
Quick Ratio
IQ_QUICK_RATIO
Avg Days Sales Outstanding
IQ_DAYS_SALES_OUT
Avg Days Payable Outstanding
IQ_DAYS_PAYABLE_OUT
Total Debt/Equity
IQ_TOTAL_DEBT_EQUITY
Total Debt/Capital
IQ_TOTAL_DEBT_CAPITAL
EBIT / Interest Expense
IQ_EBIT_INT
Capex as % of Revenues
IQ_CAPEX_PCT_REV
Total Debt/EBITDA
IQ_TOTAL_DEBT_EBITDA
Net Debt/EBITDA
IQ_NET_DEBT_EBITDA
Return on Capital %
IQ_RETURN_CAPITAL
Market Data
Mnemonics
Pricing Date
IQ_PRICEDATE
Stock Exchange
IQ_EXCHANGE
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
10
Last Sale Price
IQ_LASTSALEPRICE
Close Price
IQ_CLOSEPRICE
Dividend Adjusted Day Close Price
IQ_CLOSEPRICE_ADJ
Volume Weighted Average Price
IQ_VWAP
52 Week High Price
IQ_YEARHIGH
52 Week High Date
IQ_YEARHIGH_DATE
Daily Volume
IQ_VOLUME
Daily Value Traded
IQ_VALUE_TRADED
Market Capitalization
IQ_MARKETCAP
Enterprise Value
IQ_TEV
Shares Outstanding
IQ_SHARESOUTSTANDING
5 Year Beta
IQ_BETA_5YR
5 Year Price Volatility
IQ_PRICE_VOL_HIST_5YR
Fund NAV
IQ_FUND_NAV
Dividend Yield
IQ_DIVIDEND_YIELD
Latest Annualized Dividend Per Share
IQ_ANNUALIZED_DIVIDEND
Growth (Up to 10 years of growth)
Mnemonics
Total Revenues, 1 Yr Growth %
IQ_TOTAL_REV_1YR_ANN_GROWTH
Gross Profit, 1 Yr Growth %
IQ_GP_1YR_ANN_GROWTH
EBITDA, 1 Yr Growth %
IQ_EBITDA_1YR_ANN_GROWTH
EBIT, 1 Yr Growth %
IQ_EBIT_1YR_ANN_GROWTH
Net Income, 1 Yr Growth %
IQ_NI_1YR_ANN_GROWTH
Normalized Net Income, 1 Yr Growth %
IQ_NI_NORM_1YR_ANN_GROWTH
Diluted EPS before Extra, 1 Yr Growth %
IQ_EPS_1YR_ANN_GROWTH
Common Equity, 1 Yr Growth %
IQ_COMMON_EQUITY_1YR_ANN_GROWTH
Inventory, 1 Yr Growth %
IQ_INV_1YR_ANN_GROWTH
Total Assets, 1 Yr Growth %
IQ_TOTAL_ASSETS_1YR_ANN_GROWTH
Tangible Book Value, 1 Yr Growth %
IQ_TBV_1YR_ANN_GROWTH
Cash from Operations, 1 Yr Growth %
IQ_CFO_1YR_ANN_GROWTH
Capital Expenditures, 1 Yr Growth %
IQ_CAPEX_1YR_ANN_GROWTH
Levered Free Cash Flow, 1 Yr Growth %
IQ_LFCF_1YR_ANN_GROWTH
Unlevered Free Cash Flow, 1 Yr Growth %
IQ_UFCF_1YR_ANN_GROWTH
Dividend per Share, 1 Yr Growth %
IQ_DPS_1YR_ANN_GROWTH
Valuation
Mnemonics
TEV/Total Revenues
IQ_TEV_TOTAL_REV
TEV/EBITDA
IQ_TEV_EBITDA
TEV/EBIT
IQ_TEV_EBIT
TEV/Unlevered FCF
IQ_TEV_UFCF
Market Cap/Levered FCF
IQ_MARKET_CAP_LFCF
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
11
P/Diluted EPS before extra
IQ_PE_EXCL
P/BV
IQ_PBV
P/TangBV
IQ_PTBV
P/Sales
IQ_PRICE_SALES
TEV/Forward Total Revenue
IQ_TEV_TOTAL_REV_FWD
TEV/Forward EBITDA
IQ_TEV_EBITDA_FWD
TEV/Forward EBIT
IQ_TEV_EBIT_FWD
P/Forward Diluted EPS before extra
IQ_PE_EXCL_FWD
PEG Ratio
IQ_PEG_FWD
P/Forward CFPS
IQ_PRICE_CFPS_FWD
Company Information & Ownership
Mnemonics
Company Name
IQ_COMPANY_NAME
CIQ Company ID
IQ_COMPANY_ID
Business Description
IQ_BUSINESS_DESCRIPTION
Headquarters
IQ_COMPANY_ADDRESS
Primary Industry
IQ_PRIMARY_INDUSTRY
Number of Shareholders
IQ_NUMBER_SHAREHOLDERS
Institutional Owner
IQ_INSTITUTIONAL_OWNER
Institutional Owner Total Shares
IQ_INSTITUTIONAL_SHARES
Insider Owner
IQ_INSIDER_OWNER
Insider Owner Total Shares
IQ_INSIDER_SHARES
Holder Name
IQ_HOLDER_NAME
Holder CIQ ID
IQ_HOLDER_CIQID
Holder Total Shares
IQ_HOLDER_SHARES
Mutual Fund Name
IQ_HOLDER_FUND_NAME
Mutual Fund Shares Held
IQ_HOLDER_FUND_SHARES
Mutual Fund % of Shares Outstanding
IQ_HOLDER_FUND_PERCENT
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
12
Appendix B: Sample API Requests REQUEST 1 - Company Lookup (by Name) to get the CIQ Company ID ----------------------------------------------------------------------Function Identifiers Mnemonics Properties[1] Properties[2]
: : : : :
GDSHE MCDONALDS IQ_COMPANY_NAME_QUICK_MATCH, IQ_COMPANY_ID_QUICK_MATCH startRank = 1 endRank = 5
REQUEST 1 RESULTS - List of Company Names & IDs (by rank) ----------------------------------------------------------------------1 | 2 | 3 | 4 | 5 | -1 | 2 | 3 | 4 | 5 |
McDonald's Corp. McDonald's Holdings Company (Japan), Ltd. McDonald's Restaurants Limited Happy Family Foods Ltd. Mcdonaldís Co. (Japan) Ltd. IQ139488 IQ6561811 IQ5472699 IQ108545353 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_QUIC K_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 Limited 4 | Happy Family Foods Ltd. 5 | Mcdonaldís Co. (Japan) Ltd. -1 | IQ139488 2 | IQ6561811
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
13
3 | IQ5472699 4 | IQ108545353 5 | IQ31271459
REQUEST 2 - Company Comps (by ID) to get Top 10 Comp Companies ----------------------------------------------------------------------Function Identifiers Mnemonics Properties[1] Properties[2]
: : : : :
GDSHE IQ139488 IQ_QUICK_COMP startRank = 1 endRank = 10
REQUEST 2 RESULTS - List of Top 10 Comp Companies Ticker IDs (by rank) ----------------------------------------------------------------------1 | NYSE:YUM 2 | NYSE:CMG 3 | NasdaqGS:SBUX 4 | LSE:CPG 5 | NasdaqGS:WEN 6 | NasdaqGS:JACK 7 | NYSE:BKW 8 | NYSE:DRI 9 | NasdaqGS:DNKN 10| 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 : GDSP Identifiers : IQ139488 Mnemonics : IQ_COMPANY_NAME, IQ_COMPANY_TICKER, IQ_MARKETCAP, IQ_SHARESOUTSTANDING ------------Function : GDSP Identifiers : IQ139488 Mnemonics : IQ_TOTAL_REV, IQ_NI Properties[1] : periodType = IQ_FY Properties[2] : restatementTypeId = LFR Properties[3] : filingMode = P Properties[4] : currencyId = USD Properties[5] : currencyConversionModeId = Historical ------------Function : GDSP Identifiers : IQ139488
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
14
Mnemonics Properties[1] Properties[2] Properties[3] Properties[4] Properties[5] ------------Function Identifiers Mnemonics Properties[1] Properties[2] Properties[3] Properties[4] Properties[5] ------------Function Identifiers Mnemonics Properties[1] Properties[2] Properties[3] Properties[4] Properties[5] ------------Function Identifiers Mnemonics Properties[1] Properties[2] Properties[3] Properties[4] Properties[5] ------------Function Identifiers Mnemonics Properties[1] Properties[2] Properties[3] Properties[4] Properties[5] ------------Function Identifiers Mnemonics Properties[1] Properties[2] Properties[3]
: : : : : :
IQ_TOTAL_REV, IQ_NI periodType restatementTypeId filingMode currencyId currencyConversionModeId
= = = = =
IQ_FY-1 LFR P USD Historical
: : : : : : : :
GDSP IQ139488 IQ_TOTAL_REV, IQ_NI periodType restatementTypeId filingMode currencyId currencyConversionModeId
= = = = =
IQ_FQ LFR P USD Historical
: : : : : : : :
GDSP IQ139488 IQ_TOTAL_REV, IQ_NI periodType restatementTypeId filingMode currencyId currencyConversionModeId
= = = = =
IQ_FQ-1 LFR P USD Historical
: : : : : : : :
GDSP IQ139488 IQ_TOTAL_REV, IQ_NI periodType restatementTypeId filingMode currencyId currencyConversionModeId
= = = = =
IQ_FQ-2 LFR P USD Historical
: : : : : : : :
GDSP IQ139488 IQ_TOTAL_REV, IQ_NI periodType restatementTypeId filingMode currencyId currencyConversionModeId
= = = = =
IQ_FQ-3 LFR P USD Historical
: : : : : :
GDSHE IQ139488 IQ_CLOSEPRICE startDate = 09/01/2014 currencyId = USD currencyConversionModeId = Historical
REQUEST 3 RESULTS - Company Specific (Current) Period Specific Financials Market Data (Daily) ----------------------------------------------------------------------current current
| IQ_COMPANY_NAME | IQ_COMPANY_TICKER
| McDonald's Corp. | NYSE:MCD
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
15
current current IQ_FY IQ_FY IQ_FY-1 IQ_FY-1 IQ_FQ IQ_FQ IQ_FQ-1 IQ_FQ-1 IQ_FQ-2 IQ_FQ-2 IQ_FQ-3 IQ_FQ-3 09/02/2014 09/03/2014 09/04/2014
| | | | | | | | | | | | | | | | |
IQ_MARKETCAP IQ_SHARESOUTSTANDING IQ_TOTAL_REV IQ_NI IQ_TOTAL_REV IQ_NI IQ_TOTAL_REV IQ_NI IQ_TOTAL_REV IQ_NI IQ_TOTAL_REV IQ_NI IQ_TOTAL_REV IQ_NI IQ_CLOSEPRICE IQ_CLOSEPRICE IQ_CLOSEPRICE
| | | | | | | | | | | | | | | | |
91123.011200 981.929000 28105.700000 5585.900000 27567.000000 5464.800000 7181.700000 1387.100000 6700.300000 1204.800000 7093.200000 1397.000000 7323.400000 1522.200000 92.800000 93.140000 93.010000
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
16
Appendix C: Error Responses API Error Message AGGREGATEREQUESTTOOLARGE ANALYSTNAMENOTREPORTED ANALYSTNOTPROFILED CANNOTDISPLAYLISTSWITHOVER10000CONSTITUENTS CAPABILITYNEEDED CURRENCYNOTAVAILABLE DATACANNOTBEAGGREGATED DATA UNAVAILABLE DETAILEDDATAUNAVAILABLE ENTITLEMENTNEEDED ERROR GETTING DATA ERROR PROCESSING FUNCTION ERROR PROCESSING THE REQUEST ESCAPE WORDS NOT ALLOWED EXCEEDED THE RATE LIMIT EXCEEDS5YEARLIMIT EXCEEDS8YEARLIMIT FREQUENCY NOT APPLICABLE FUNCTION MISMATCH GDS CURRENTLY UNAVAILABLE - PLEASE TRY AGAIN LATER HISTORICALDATANOTAVAILABLEFORREQUESTEDLISTT YPE INPUT ARGUMENTS MISSING INVALIDASOFDATE INVALIDCONTRIBUTOR INVALIDCOUNT INVALIDCURRENCY INVALIDCURRENCYREQUEST INVALIDDATAVENDOR INVALID DATE ARGUMENT INVALID DATE ENTERED INVALID DATE RANGE FOR FREQUENCY INVALIDDISPLAY INVALIDENTRY INVALIDFACTORCODE INVALID FISCAL DATE FORMAT INVALIDFORMULAMETRIC INVALID FREQUENCY
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
Readable Format Aggregate Request Too Large Analyst Name Not Reported Analyst Not Profiled Cannot Display Lists With Over 10,000 Constituents Capability Needed Currency Not Available Data Cannot Be Aggregated Data Unavailable Detailed Data Unavailable Entitlement Needed Error Getting Data - Please Try Again! Error Processing Function Please Try Again! Error Processing the Reques! (JSON Direct Input) Escape Words Not Allowed Exceeded The Rate Limit Exceeds 5 Year Limit Exceeds 8 Year Limit Frequency Not Applicable Function Mismatch GDS Currently Unavailable Please Try Again Later! Historical Data Not Available For Requested List Type Input Arguments Missing Invalid AsOfDate Invalid Contributor Invalid Count Invalid Currency Invalid Currency Request Invalid Data Vendor Invalid Date Argument Invalid Date Entered Invalid Date Range For Frequency Invalid Display Invalid Entry Invalid Factor Code Invalid Fiscal Date Format Invalid Formula Metric Invalid Frequency
17
INVALID FUNCTION INVALID IDENTIFIER INVALIDIDENTIFIER INVALIDINDEX INVALIDLISTID INVALIDMETRIC INVALID MNEMONIC INVALIDPARAMETERS INVALIDPERIODRANGE INVALIDPERIODTYPE INVALIDRATING INVALIDRATINGCHARACTERISTIC INVALIDRATINGOPTION INVALIDRATIO INVALID REQUEST INVALIDRESTATEMENTTYPE INVALIDSECONDPARTY INVALIDSECTOR INVALID SENIORITY CODE INVALID SNAP TYPE INVALIDSOLICITATION INVALIDTENOR INVALIDTIMEPERIOD INVALIDTRANSACTIONID INVALIDWEIGHTTYPE NEWDATAAVAILABLE NONE NOT APPLICABLE NOT ENTITLED NOTSUPPORTED NOTSUPPORTEDIDENTIFIER ONLYCONSENSUSAVAILABLE PLEASE AUTHENTICATE REQUEST NOT PROCESSED REQUEST TIMED OUT REQUESTTOOLARGE SECONDPARTYINVALID SENIORITY CODE NOT APPLICABLE SNAP TYPE NOT APPLICABLE SUBSCRIPTION LIMIT THE REMOTE SERVER RETURNED AN ERROR: (400) BAD REQUEST. THERE WAS AN ERROR PROCESSING YOUR REQUEST
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
Invalid Function Invalid Identifier Invalid Identifier Invalid Index Invalid List Identifier Invalid Metric Invalid Mnemonic Invalid Parameters Invalid Period Range Invalid Period Type Invalid Rating Invalid Rating Characteristic Invalid Rating Option Invalid Ratio Invalid Request Invalid Restatement Type Invalid Second Party Invalid Sector Invalid Seniority Code Invalid Snap Type Invalid Solicitation Invalid Tenor Invalid Time Period Invalid Transaction Identifier Invalid Weight Type New Data Available None Not Applicable Not Entitled Not Supported Not Supported Identifier Only Consensus Available Please Authenticate Request Not Processed - Please Try Again! Request Timed Out - Please Try Again! Request Too Large Second Party Invalid Seniority Code Not Applicable Snap Type Not Applicable Subscription Limit The Remote Server Returned An Error: (400) BAD REQUEST There Was An Error Processing Your Request!
18
THEREWASANERRORPROCESSINGYOURREQUEST TOOMANYLISTCONSTITUENTS UNEXPECTED ERROR - PLEASE TRY AGAIN LATER USERACCESSRESTRICTED USERNAME FOR DESTINATION SYSTEM IS NOT MAPPED.
S&P Capital IQ Tablet Application Challenge, Fall 2014 www.spcapitaliq-‐njit.com
There Was An Error Processing Your Request! Too Many List Constituents Unexpected Error - Please Try Again! User Access Restricted Username For Destination System Is Not Mapped
19