Professional Documents
Culture Documents
On-Demand Access
Client Support
Email support.api.mi@spglobal.com
Client Support Website support.marketplace.spglobal.com
1 Document Overview
Introduction
API Drive is an enterprise on-demand platform that you can use to submit your unique portfolio of
company or security identifiers and a unique set of data metrics. Your custom portfolio data is returned to
you on our FTP server as a delimited flat file, which can be imported into a data management system
such as Microsoft Access, Microsoft Excel, SQL, and ORACLE.
Document Purpose
This document provides information for clients who subscribe to API Drive. This guide provides you with:
• an overview of the data sets, identifiers and data points available in API Drive
• an understanding of the S&P Global Enterprise Data Exchange (EDX) platform using the
TCP/IP protocol FTP
• the requirements and steps to upload and download files on the EDX
• formatting requirements for submitting files to S&P Global Market Intelligence
• the format in which you will receive files from S&P Global Market Intelligence
Client Support
We are committed to quality products and customer service. Any time you have questions about your
data, you will find our Client Support Center to be an important resource. For 24/7 support, email
APISupport@spglobal.com.
1
S&P Global Market Intelligence
Data Sets
API Drive provides one of the industry’s most comprehensive sets of global data—from a broad range of
Fundamental, Industry Specific and Segment Data, Valuations & Pricing, Standard & Poor’s Credit
Ratings and Research to Reference and Terms & Conditions data. S&P Global Market Intelligence data
supports a Full Spectrum of Investor Functions.
For a list and description of data sets, please refer to the API Developer’s Guide on the API Support Site.
Identifiers
With API Drive, your portfolios can be completely customized. You may base your portfolios on any of the
following criteria:
A Security is a financial instrument that may be traded on one or on multiple exchanges. You can
designate the securities you want in your portfolio. Since API Drive can match all identifiers related to a
security, you may submit any identifier including:
CUSIP9 ISIN
CINS9 RatingsXpress Instrument ID
SEDOL
A Trading Item represents the equivalent of a security + the exchange on which it trades. For example,
the common stock for Teva Pharmaceuticals trades on both the NYSE and the Tel Aviv exchanges. A
tradingItem differentiates between the two exchanges on which the security trades.
CIQ Ticker:Exchange
CIQ Trading Item ID
An Entity uniquely identifies a legal corporate structure or legal object. An Issuer is a legal organization
that issues any type of security. With API Drive, you define the entities and/or issuers you want in your
portfolio. Since API Drive can match all identifiers related to an entity or issuer, you may submit any
identifier including:
CIQ Company ID CUSIP6
Compustat GVKEY CINS6
RatingsXpress Entity ID CABRE
D&B DUNS ID CMA Entity ID
2
API Drive Developer’s Guide
Functions
After you have determined the data points / mnemonics you’d like to display, you will need to choose the
appropriate function to pull your data. Following is a description of each of the functions that can be used
to retrieve S&P Global data.
This function retrieves a single data point for a point in time value for a mnemonic either current or
historical. Default inputs include a Mnemonic and a Security/Entity Identifier.
Example
Within Terms & Conditions data, this function can be used to retrieve the Coupon Rate (mnemonic
COUPON_RATE) for a specific Security Identifier. A single data point is returned for the Security Identifier
passed into the function.
This function retrieves an array (a set of values) for the most current availability of content either end of
day or intraday. The retrieved values are given in header and data value output classes, and typically
represent a schedule, cash flows, or other items that involve multiple data values for the most current end
of day. Default inputs include a Mnemonic and a Security/Entity Identifier.
Example
Within Terms & Conditions data, this function can be used to retrieve the most recent Call Schedule
(mnemonic CALL_SCHEDULE) for a specific Security Identifier. Headers and data values are returned for
Call Type, Call Date, Call Schedule Price, and other data points that represent the current call schedule
for that security.
3
S&P Global Market Intelligence
This function retrieves a set of GDSP mnemonics that belong to a specific group. This is a convenience
function—instead of making multiple calls using GDSP, this allows you to grab several mnemonics that
pertain to the same group of data. The most current end of day values are returned for the set of GDSP
mnemonics. Inputs include a Group Mnemonic (there are specific mnemonics available for this function)
and a Security/Entity Identifier.
Example
Within Terms and Conditions data, there are approximately 27 mnemonics that pertain to the Basic
Security Description, including COUPON_RATE, COUPON_TYPE, DATED_DATE, and others. Instead of
making individual GDSP calls for each of these mnemonics, a GDSG function call can be made with the
mnemonic BASIC_SECURITY_DESCRIPTION to retrieve all 27 mnemonics.
This function retrieves historical values for a mnemonic over a range of dates. Data values are returned
according to the time series of dates. Default inputs include a Mnemonic, a Security/Entity Identifier, a
start date, and an end date.
Example
Within Pricing data, this function can be used to retrieve the time series of Bid Prices (BID_PRICE) for a
given security over a range of dates. In the following example, a range from 08-01-2000 to 08-31-2011
was specified for a given security:
BID_PRICE PRICE_DATE_D
100.228 05/27/2011
100.3 05/07/2011
100.3 05/06/2011
100.42 02/18/2011
100.67 08/25/2010
100.63 07/26/2010
100.63 07/02/2010
100.63 05/25/2010
This function retrieves an array or set of values over a historical range of dates. Data values are returned
according to the time series of dates. Default inputs include a Mnemonic, a Security/Entity Identifier, a
start date, and an end date.
Example
Within S&P Global Ratings data, the Standard Instrument Credit Rating (INS_STD_CREDIT_RATING)
can be retrieved for an entity based on a date range. A table of credit ratings is returned where one
header specifies the date.
This function retrieves historical values for a mnemonic over a range of dates, where a specific frequency
can be specified—Annual (A), Quarterly (Q), Monthly (M), Weekly (W), or Daily (D). Header rows for the
returned values represent the dates of the periodic values. Default inputs include a Mnemonic, a
Security/Entity Identifier, a start date, an end date, and a frequency.
4
API Drive Developer’s Guide
Example
Within Pricing data, this function can be used to retrieve the Ask Price (ASK_PRICE) of a security based
on a date range and a specified frequency of Daily (D) or Weekly (W). The following data shows what is
returned for Ask Price for a given security where the frequency is specified as Weekly and the date range
is from 1/1/2010 to 1/31/2010:
5
S&P Global Market Intelligence
Firewall Rules
If your IT department needs to create new rules on your firewall to allow access to EDX, please make
sure the new firewall rules include both Production and Disaster Recovery IP addresses.
Login Configurations
Your account team will work with you to determine the appropriate login configuration for SFTP or FTPS
Your account team will ask you for.
• Remote Host or URL hosting SFTP or FTPS Services
• Remote Port
• Remote Username and Password or Remote Username and SSH Authorized User Key
• Remote Directory
Production-1 Production-2
EDX FTP URLs Protocols Port #
IP Address IP Address
The actual port numbers used do vary based on the Secure FTP selected. You can find them below:
• SFTP (Secure File Transfer Protocol):
o SSH Port: 22
• SFTP (Password Less/Public Key):
o SSH Port: 22
If you need to switch to SFTP (Public Key), please contact API Support at
APISupport@spglobal.com with the following information:
Your firm’s SSH Key.
6
API Drive Developer’s Guide
7
S&P Global Market Intelligence
Login Credentials
In order to access the EDX FTP server, a valid user name and password are required. Your password will
be assigned to you by S&P Global Market Intelligence. Please keep in mind the following:
User ID
• User IDs are case sensitive.
• User IDs can be customized, but there are some restrictions:
• Must be between 5 and 12 characters
• Cannot have spaces or symbols
Password
• Passwords are case sensitive.
• Passwords can be customized, but there are some restrictions:
• Minimum of six characters
• One character must be upper case, lower case and numeric
• Underscores are allowed; symbols are not.
• Passwords are secure and cannot be retrieved by S&P Global Market Intelligence staff. If the
password is lost, please contact Client Support to request a new password.
Users will be automatically logged out after 10 minutes of inactivity.
Directories
Your EDX site will display three folders:
You may submit your API Drive Request Files to the Outbox folder any time the EDX Site is available.
API Drive Response Files are delivered to your Inbox folder as soon as they are available. Response
Files will remain in your Inbox for one day and will then be moved to the Archive folder every day at 5:00
am UTC. API Drive Response files should be posted within an hour of making the request. However, they
are usually made available sooner.
API Drive Response Files that have been moved from your Inbox will remain in your Archive folder for 30
days. After 30 days, the files will be purged at 5:00 am UTC each day.
8
API Drive Developer’s Guide
4 File Formats
Input Files
Your Input filename should always be named APIDRIVE_INPUT*.txt. The input file must always begin
with APIDRIVE_INPUT and end with .txt. (The asterisk represents a wildcard.) Your Input file name
should always contain the .txt extension.
To produce meaningful data, your Input File should contain at a minimum the:
• FUNCTION *
• IDENTIFIER
• MNEMONIC
* Additional data attributes for functions available in various data sets can be found on the API Support
Site.
You may select any order of header keys. Below is an example of a header row in an Input File.
FUNCTION|IDENTIFIER|MNEMONIC|ASOFDATE|STARTDATE|ENDDATE|FREQUENCY
Output Files
A single output file will be generated for all of your requests. Each mnemonic function request response
will be written to the file as:
• Request
• Header
• Value
9
S&P Global Market Intelligence
Pricing Data
This function retrieves a single data point for a point in time value for a mnemonic either current or
historical. The example below shows a pricing request for a security using the GDSP function.
Input
GDSP|00083BAB1|ASK_PRICE|06/03/2016|||
GDSP|00083BAB1|ASK_YIELD|06/03/2016|||
GDSP|00083BAB1|BID_PRICE|06/03/2016|||
GDSP|00083BAB1|BID_YIELD|06/03/2016|||
GDSP|00083BAB1|MARKET_SPREAD|06/03/2016|||
GDSP|00083BAB1|MEAN_PRICE|06/03/2016|||
GDSP|00083BAB1|MEAN_YIELD|06/03/2016|||
Output
1|1|GDSP|00083BAB1|ASK_PRICE|06/03/2016|||
1|2|ASK_PRICE
1|3|87.115
2|1|GDSP|00083BAB1|ASK_YIELD|06/03/2016|||
2|2|ASK_YIELD
2|3|5.971
3|1|GDSP|00083BAB1|BID_PRICE|06/03/2016|||
3|2|BID_PRICE
3|3|84.475
4|1|GDSP|00083BAB1|BID_YIELD|06/03/2016|||
4|2|BID_YIELD
4|3|6.507
5|1|GDSP|00083BAB1|MARKET_SPREAD|06/03/2016|||
5|2|MARKET_SPREAD
5|3|497
6|1|GDSP|00083BAB1|MEAN_PRICE|06/03/2016|||
6|2|MEAN_PRICE
6|3|85.795
7|1|GDSP|00083BAB1|MEAN_YIELD|06/03/2016|||
7|2|MEAN_YIELD
7|3|6.239
10
API Drive Developer’s Guide
This function retrieves historical values for a mnemonic over a range of dates. The example below shows
a pricing request for a security using the GDSHE function.
Input
GDSHE|123456789|ASK_PRICE||03-12-2015|16-03-2015||
GDSHE|00083BAB1|ASK_PRICE|01/01/2016|01/15/2016||
GDSHE|00083BAB1|ASK_YIELD|01/01/2016|01/15/2016||
GDSHE|00083BAB1|BID_PRICE|01/01/2016|01/15/2016||
GDSHE|00083BAB1|BID_YIELD|01/01/2016|01/15/2016||
GDSHE|00083BAB1|MEAN_PRICE|01/01/2016|01/15/2016||
GDSHE|00083BAB1|MEAN_YIELD|01/01/2016|01/15/2016||
Output
8|1|GDSHE|00083BAB1|ASK_PRICE|01/01/2016|01/15/2016||
8|2|ASK_PRICE|PRICE_DATE_D
8|3|97.131|01/15/2016
8|4|96.67|01/14/2016
8|5|96.805|01/13/2016
8|6|96.491|01/12/2016
8|7|96.036|01/11/2016
8|8|96.317|01/08/2016
8|9|95.443|01/07/2016
8|10|95.197|01/06/2016
8|11|94.634|01/05/2016
8|12|94.593|01/04/2016
9|1|GDSHE|00083BAB1|ASK_YIELD|01/01/2016|01/15/2016||
9|2|ASK_YIELD|PRICE_DATE_D
9|3|4.122|01/15/2016
9|4|4.181|01/14/2016
9|5|4.163|01/13/2016
9|6|4.206|01/12/2016
9|7|4.266|01/11/2016
9|8|4.23|01/08/2016
9|9|4.345|01/07/2016
9|10|4.378|01/06/2016
9|11|4.453|01/05/2016
9|12|4.458|01/04/2016
10|1|GDSHE|00083BAB1|BID_PRICE|01/01/2016|01/15/2016||
10|2|BID_PRICE|PRICE_DATE_D
10|3|94.078|01/15/2016
10|4|93.636|01/14/2016
10|5|93.775|01/13/2016
10|6|93.468|01/12/2016
10|7|93.029|01/11/2016
10|8|93.307|01/08/2016
10|9|92.472|01/07/2016
10|10|92.234|01/06/2016
11
S&P Global Market Intelligence
10|11|91.693|01/05/2016
10|12|91.661|01/04/2016
11|1|GDSHE|00083BAB1|BID_YIELD|01/01/2016|01/15/2016||
11|2|BID_YIELD|PRICE_DATE_D
11|3|4.518|01/15/2016
11|4|4.578|01/14/2016
11|5|4.56|01/13/2016
11|6|4.602|01/12/2016
11|7|4.662|01/11/2016
11|8|4.627|01/08/2016
11|9|4.741|01/07/2016
11|10|4.775|01/06/2016
11|11|4.85|01/05/2016
11|12|4.855|01/04/2016
12|1|GDSHE|00083BAB1|MEAN_PRICE|01/01/2016|01/15/2016||
12|2|MEAN_PRICE|PRICE_DATE_D
12|3|95.605|01/15/2016
12|4|95.153|01/14/2016
12|5|95.29|01/13/2016
12|6|94.98|01/12/2016
12|7|94.533|01/11/2016
12|8|94.812|01/08/2016
12|9|93.958|01/07/2016
12|10|93.715|01/06/2016
12|11|93.163|01/05/2016
12|12|93.127|01/04/2016
13|1|GDSHE|00083BAB1|MEAN_YIELD|01/01/2016|01/15/2016||
13|2|MEAN_YIELD|PRICE_DATE_D
13|3|4.32|01/15/2016
13|4|4.38|01/14/2016
13|5|4.362|01/13/2016
13|6|4.404|01/12/2016
13|7|4.464|01/11/2016
13|8|4.429|01/08/2016
13|9|4.543|01/07/2016
13|10|4.576|01/06/2016
13|11|4.652|01/05/2016
13|12|4.657|01/04/2016
12
API Drive Developer’s Guide
This function retrieves an array (a set of values) for the most current availability of content either end of
day or intraday. The example below shows a pricing request for a security using the GDSPV function.
Input
GDSPV|C_USD|GOVT_TREASURY_CURVE||||
GDSPV|C_USD|SWAP_CURVE||||
GDSPV|CMA_1589|CDS_CURVE_STD||||SEN
Output
14|1|GDSPV|C_USD|GOVT_TREASURY_CURVE||||
14|2|TERM|MID_YIELD|BASIS|MV1_SNAP_DATE
14|3|0.083|0.1729|ACT/360|2016-06-03 08:30:00
14|4|0.25|0.2772|ACT/360|2016-06-03 08:30:00
14|5|0.50|0.4649|ACT/360|2016-06-03 08:30:00
14|6|1|0.6684|ACT/360|2016-06-03 08:30:00
14|7|2|0.871|ACT/365|2016-06-03 08:30:00
14|8|3|1.0291|ACT/365|2016-06-03 08:30:00
14|9|5|1.3425|ACT/365|2016-06-03 08:30:00
14|10|7|1.6084|ACT/365|2016-06-03 08:30:00
14|11|10|1.7895|ACT/365|2016-06-03 08:30:00
14|12|30|2.5733|ACT/365|2016-06-03 08:30:00
15|1|GDSPV|C_USD|SWAP_CURVE||||
15|2|PERIOD_IN_YEARS|RATE|DESCRIPTION|MV1_SNAP_DATE
15|3|1|1.088|Act/360 Ann vs 6 month $ LIBOR|2016-06-03 08:30:00
15|4|1|.877|(30/360)Semi Ann vs 3M $LIBOR|2016-06-03 08:30:00
15|5|1|1.101|(30/360)Semi Ann vs 6M $LIBOR|2016-06-03 08:30:00
15|6|1|.706|Act/360 Ann vs 1 month $ LIBOR|2016-06-03 08:30:00
15|7|1|.866|Act/360 Ann vs 3 month $ LIBOR|2016-06-03 08:30:00
15|8|2|1.021|(30/360)Semi Ann vs 3M $LIBOR|2016-06-03 08:30:00
15|9|2|1.234|(30/360)Semi Ann vs 6M $LIBOR|2016-06-03 08:30:00
15|10|2|.846|Act/360 Ann vs 1 month $ LIBOR|2016-06-03 08:30:00
15|11|2|1.01|(Act/360)Ann vs 3month $LIBOR|2016-06-03 08:30:00
15|12|2|1.22|Act/360 Ann vs 6 month $ LIBOR|2016-06-03 08:30:00
15|13|2|1.033|(Act/360) Qtly vs 3m $LIBOR|2016-06-03 08:30:00
15|14|2|1.02|(Act/360) Semi vs 3m $LIBOR|2016-06-03 08:30:00
15|15|2|1.022|(30/360) Ann vs 3m $LIBOR|2016-06-03 08:30:00
15|16|2|1.019|(30/360) Qtly vs 3m $LIBOR|2016-06-03 08:30:00
15|17|3|1.136|(Act/360) Semi vs 3m $LIBOR|2016-06-03 08:30:00
15|18|3|1.138|(30/360) Ann vs 3m $LIBOR|2016-06-03 08:30:00
15|19|3|1.134|(30/360) Qtly vs 3m $LIBOR|2016-06-03 08:30:00
15|20|3|1.143|(30/360)Semi Ann vs 3M $LIBOR|2016-06-03 08:30:00
15|21|3|1.331|(30/360)Semi Ann vs 6M $LIBOR|2016-06-03 08:30:00
15|22|3|.949|Act/360 Ann vs 1 month $ LIBOR|2016-06-03 08:30:00
15|23|3|1.131|(Act/360)Ann vs 3month $LIBOR|2016-06-03 08:30:00
15|24|3|1.316|Act/360 Ann vs 6 month $ LIBOR|2016-06-03 08:30:00
15|25|3|1.15|(Act/360) Qtly vs 3m $LIBOR|2016-06-03 08:30:00
15|26|4|1.225|(Act/360) Semi vs 3m $LIBOR|2016-06-03 08:30:00
13
S&P Global Market Intelligence
14
API Drive Developer’s Guide
15
S&P Global Market Intelligence
16
API Drive Developer’s Guide
16|3|2016-06-03 08:00:00|0.5|91.78|454.15|92.2|453.93|-2.24999|-
0.24997|100.24997|102.24999|D|5.29|0.54979538705459|1.69|7
16|4|2016-06-03
08:00:00|1|864.42|1069.66|883.99|1099.73|3.74996|5.74999|94.25|96.25003|D|26.59|1.0207208
2436964|11.19|7
16|5|2016-06-03
08:00:00|2|1121.04|1361.24|1183.3|1462.75|11.49994|15.49991|84.50008|88.50005|D|18.06|1.8
2716397584613|25.87|7
16|6|2016-06-03
08:00:00|3|1268.87|1418.63|1399.97|1581.31|19.49988|22.49988|77.50011|80.50011|D|18.51|2.
49408121133416|38.39|7
16|7|2016-06-03
08:00:00|4|1545.92|1652.05|1931.43|2082.77|32.00001|34.00015|65.99984|67.99998|D|32.38|3.
00664350475041|55.48|7
16|8|2016-06-03
08:00:00|5|1556.53|1655.59|2037.29|2205.7|36.5011|38.5012|61.49879|63.49889|O|18.92|3.394
45715056875|63.15|7
16|9|2016-06-03
08:00:00|6|1490.74|1601.72|1950.73|2176.76|37.57025|40.23003|59.76996|62.42974|D|10.54|3.
72297921112774|66.84|7
16|10|2016-06-03
08:00:00|7|1442.18|1562.65|1906.68|2190.71|38.56935|41.7652|58.23479|61.43064|D|10.68|4.0
1301138311701|70.2|7
16|11|2016-06-03
08:00:00|8|1368.9|1541.45|1774.99|2273.65|37.98427|43.44286|56.55713|62.01572|D|8|4.27262
232758174|72.49|7
16|12|2016-06-03
08:00:00|9|1307.9|1525.51|1674.02|2385.26|37.43901|44.88419|55.1158|62.56098|D|8.06|4.506
60918473606|74.62|7
16|13|2016-06-03
08:00:00|10|1256.36|1513.23|1594.2|2522.84|36.92871|46.12076|53.87923|63.07128|D|8.1|4.71
770553885417|76.6|7
17
S&P Global Market Intelligence
The example below shows a pricing request for a security using the GDST function.
Input
GDST|123456789|ASK_PRICE||12-03-2015|16-03-2015|D|
GDST|00083BAB1|ASK_PRICE|01/01/2013|01/01/2016|A|
GDST|00083BAB1|ASK_YIELD|01/01/2013|01/01/2016|A|
GDST|00083BAB1|BID_PRICE|01/01/2013|01/01/2016|A|
GDST|00083BAB1|BID_YIELD|01/01/2013|01/01/2016|A|
GDST|00083BAB1|MEAN_PRICE|01/01/2013|01/01/2016|A|
GDST|00083BAB1|MEAN_YIELD|01/01/2013|01/01/2016|A|
Output
17|1|GDST|00083BAB1|ASK_PRICE|01/01/2013|01/01/2016|A|
17|2|12/31/2013|12/31/2014|12/31/2015
17|3|101.442|98.475|94.234
18|1|GDST|00083BAB1|ASK_YIELD|01/01/2013|01/01/2016|A|
18|2|12/31/2013|12/31/2014|12/31/2015
18|3|4.053|4.216|4.478
19|1|GDST|00083BAB1|BID_PRICE|01/01/2013|01/01/2016|A|
19|2|12/31/2013|12/31/2014|12/31/2015
19|3|96.996|96.512|91.299
20|1|GDST|00083BAB1|BID_YIELD|01/01/2013|01/01/2016|A|
20|2|12/31/2013|12/31/2014|12/31/2015
20|3|4.541|4.562|4.875
21|1|GDST|00083BAB1|MEAN_PRICE|01/01/2013|01/01/2016|A|
21|2|12/31/2013|12/31/2014|12/31/2015
21|3|99.219|97.493|92.767
22|1|GDST|00083BAB1|MEAN_YIELD|01/01/2013|01/01/2016|A|
22|2|12/31/2013|12/31/2014|12/31/2015
22|3|4.297|4.389|4.677
18
API Drive Developer’s Guide
Financial Data
This function retrieves a single data point for a point in time value for a mnemonic either current or
historical. The example below shows a financial data request for a company using the GDSP function.
Input
GDSP|IQ873932|IQ_CASH_INVEST|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_EBITDA|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_EPS_NORM|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_INC_TAX|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_NET_CHANGE|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_NI|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_SGA|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_TOTAL_DEBT|IQ_FY|LC|P|06/03/2016
GDSP|IQ873932|IQ_TOTAL_REV|IQ_FY|LC|P|06/03/2016
Output
1|1|GDSP|IQ873932|IQ_CASH_INVEST|IQ_FY|LC|P|06/03/2016
1|2|IQ_CASH_INVEST
1|3|-27.417000
2|1|GDSP|IQ873932|IQ_EBITDA|IQ_FY|LC|P|06/03/2016
2|2|IQ_EBITDA
2|3|24.370000
3|1|GDSP|IQ873932|IQ_EPS_NORM|IQ_FY|LC|P|06/03/2016
3|2|IQ_EPS_NORM
3|3|0.253337
4|1|GDSP|IQ873932|IQ_INC_TAX|IQ_FY|LC|P|06/03/2016
4|2|IQ_INC_TAX
4|3|2.757000
5|1|GDSP|IQ873932|IQ_NET_CHANGE|IQ_FY|LC|P|06/03/2016
5|2|IQ_NET_CHANGE
5|3|-2.375000
6|1|GDSP|IQ873932|IQ_NI|IQ_FY|LC|P|06/03/2016
6|2|IQ_NI
6|3|-1.268000
7|1|GDSP|IQ873932|IQ_SGA|IQ_FY|LC|P|06/03/2016
7|2|IQ_SGA
7|3|26.933000
8|1|GDSP|IQ873932|IQ_TOTAL_DEBT|IQ_FY|LC|P|06/03/2016
8|2|IQ_TOTAL_DEBT
8|3|96.751000
9|1|GDSP|IQ873932|IQ_TOTAL_REV|IQ_FY|LC|P|06/03/2016
9|2|IQ_TOTAL_REV
9|3|187.599000
19
S&P Global Market Intelligence
This function retrieves historical values for a mnemonic over a range of dates. The example below shows
a financial data request for a company using the GDSHE function.
Input
GDSHE|IQ873932|IQ_CASH_INVEST|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_EBITDA|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_EPS_NORM|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_INC_TAX|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_NET_CHANGE|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_NI|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_SGA|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_TOTAL_DEBT|IQ_FY-4|LC|P|06/03/2016
GDSHE|IQ873932|IQ_TOTAL_REV|IQ_FY-4|LC|P|06/03/2016
Output
10|1|GDSHE|IQ873932|IQ_CASH_INVEST|IQ_FY-4|LC|P|06/03/2016
10|2|IQ_CASH_INVEST|AsOfDate
10|3|-5.841000|6/3/2016
10|4|-38.523000|6/3/2016
10|5|-46.184000|6/3/2016
10|6|-34.725000|6/3/2016
10|7|-27.417000|6/3/2016
11|1|GDSHE|IQ873932|IQ_EBITDA|IQ_FY-4|LC|P|06/03/2016
11|2|IQ_EBITDA|AsOfDate
11|3|20.463000|6/3/2016
11|4|27.399000|6/3/2016
11|5|28.668000|6/3/2016
11|6|22.205000|6/3/2016
11|7|24.370000|6/3/2016
12|1|GDSHE|IQ873932|IQ_EPS_NORM|IQ_FY-4|LC|P|06/03/2016
12|2|IQ_EPS_NORM|AsOfDate
12|3|0.066741|6/3/2016
12|4|0.233421|6/3/2016
12|5|0.211978|6/3/2016
12|6|0.132517|6/3/2016
12|7|0.253337|6/3/2016
13|1|GDSHE|IQ873932|IQ_INC_TAX|IQ_FY-4|LC|P|06/03/2016
13|2|IQ_INC_TAX|AsOfDate
13|3|3.584000|6/3/2016
13|4|4.163000|6/3/2016
13|5|3.769000|6/3/2016
13|6|1.814000|6/3/2016
13|7|2.757000|6/3/2016
14|1|GDSHE|IQ873932|IQ_NET_CHANGE|IQ_FY-4|LC|P|06/03/2016
14|2|IQ_NET_CHANGE|AsOfDate
14|3|1.067000|6/3/2016
14|4|4.595000|6/3/2016
20
API Drive Developer’s Guide
14|5|-2.549000|6/3/2016
14|6|-2.214000|6/3/2016
14|7|-2.375000|6/3/2016
15|1|GDSHE|IQ873932|IQ_NI|IQ_FY-4|LC|P|06/03/2016
15|2|IQ_NI|AsOfDate
15|3|11.464000|6/3/2016
15|4|1.612000|6/3/2016
15|5|2.813000|6/3/2016
15|6|4.859000|6/3/2016
15|7|-1.268000|6/3/2016
16|1|GDSHE|IQ873932|IQ_SGA|IQ_FY-4|LC|P|06/03/2016
16|2|IQ_SGA|AsOfDate
16|3|20.762000|6/3/2016
16|4|24.474000|6/3/2016
16|5|24.790000|6/3/2016
16|6|23.745000|6/3/2016
16|7|26.933000|6/3/2016
17|1|GDSHE|IQ873932|IQ_TOTAL_DEBT|IQ_FY-4|LC|P|06/03/2016
17|2|IQ_TOTAL_DEBT|AsOfDate
17|3|52.488000|6/3/2016
17|4|81.841000|6/3/2016
17|5|102.621000|6/3/2016
17|6|92.071000|6/3/2016
17|7|96.751000|6/3/2016
18|1|GDSHE|IQ873932|IQ_TOTAL_REV|IQ_FY-4|LC|P|06/03/2016
18|2|IQ_TOTAL_REV|AsOfDate
18|3|174.792000|6/3/2016
18|4|206.367000|6/3/2016
18|5|207.035000|6/3/2016
18|6|170.909000|6/3/2016
18|7|187.599000|6/3/2016
21
S&P Global Market Intelligence
File Submissions
It is possible to receive the following error responses when submitting an Input File:
• EXCEEDED THROTTLING LIMIT *
• EMPTY OR INVALID INPUT FILE RECEIVED.
• ERROR PROCESSING REQUEST
• USER NOT FOUND
* When a request throttling limit is exceeded, an empty request file is provided. The error message will
appear in the response file.
Individual Requests
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 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
This means that one or more input arguments are missing.
Function Mismatch
This means that a mnemonic has been passed that does not work with the specific function it was
assigned to. Please use a different function with this mnemonic.
Not Entitled
This means that you are not entitled to the specific mnemonic in the data request.
Error Processing Function / Error Processing Request / Invalid Request
These are general errors. For example, there may be issues with the input parameters in the
request – an input parameter might be missing or some of the input parameters may be invalid.
Below is an example:
4|1||D2851Z|FSR_LC_LT_RATING||1/1/2005
4|2|FSR_LC_LT_RATING
4|3|Invalid Function
22
API Drive Developer’s Guide
23
7 Revision History
The changes made to this document include the following:
25
Copyright © 2021 by S&P Global Market Intelligence, a division of S&P Global Inc. All rights reserved.
These materials have been prepared solely for information purposes based upon information generally
available to the public and from sources believed to be reliable. No content (including index data, ratings,
credit-related analyses and data, research, model, software or other application or output therefrom) or
any part thereof (Content) may be modified, reverse engineered, reproduced or distributed in any form by
any means, or stored in a database or retrieval system, without the prior written permission of S&P Global
Market Intelligence or its affiliates (collectively, S&P Global). The Content shall not be used for any
unlawful or unauthorized purposes. S&P Global and any third-party providers, (collectively S&P Global
Parties) do not guarantee the accuracy, completeness, timeliness or availability of the Content. S&P
Global Parties are not responsible for any errors or omissions, regardless of the cause, for the results
obtained from the use of the Content. THE CONTENT IS PROVIDED ON “AS IS” BASIS. S&P GLOBAL
PARTIES DISCLAIM ANY AND ALL EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, ANY WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE OR USE, FREEDOM FROM BUGS, SOFTWARE ERRORS OR DEFECTS, THAT THE
CONTENT’S FUNCTIONING WILL BE UNINTERRUPTED OR THAT THE CONTENT WILL OPERATE
WITH ANY SOFTWARE OR HARDWARE CONFIGURATION. In no event shall S&P Global Parties be
liable to any party for any direct, indirect, incidental, exemplary, compensatory, punitive, special or
consequential damages, costs, expenses, legal fees, or losses (including, without limitation, lost income
or lost profits and opportunity costs or losses caused by negligence) in connection with any use of the
Content even if advised of the possibility of such damages.
S&P Global Market Intelligence’s opinions, quotes and credit-related and other analyses are statements
of opinion as of the date they are expressed and not statements of fact or recommendations to purchase,
hold, or sell any securities or to make any investment decisions, and do not address the suitability of any
security. S&P Global Market Intelligence may provide index data. Direct investment in an index is not
possible. Exposure to an asset class represented by an index is available through investable instruments
based on that index. S&P Global Market Intelligence assumes no obligation to update the Content
following publication in any form or format. The Content should not be relied on and is not a substitute for
the skill, judgment and experience of the user, its management, employees, advisors and/or clients when
making investment and other business decisions. S&P Global keeps certain activities of its divisions
separate from each other in order to preserve the independence and objectivity of their respective
activities. As a result, certain divisions of S&P Global may have information that is not available to other
S&P Global divisions. S&P Global has established policies and procedures to maintain the confidentiality
of certain non- public information received in connection with each analytical process.
S&P Global may receive compensation for its ratings and certain analyses, normally from issuers or
underwriters of securities or from obligors. S&P Global reserves the right to disseminate its opinions and
analyses. S&P Global's public ratings and analyses are made available on its Web sites,
www.standardandpoors.com (free of charge) and www.ratingsdirect.com (subscription), and may be
distributed through other means, including via S&P Global publications and third-party redistributors.
Additional information about our ratings fees is available at www.standardandpoors.com/usratingsfees.
26