Professional Documents
Culture Documents
Api Properties Matrix
Api Properties Matrix
Following is a list of Specialized Data Request Properties that can be used to retrieve specific types of mnemonics:
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
This property applies to Credit Analytics Data (i.e., the Credit Indicators data
category), Indicates the end period of the period range for which value is to be
calculated for the mnemonic (e.g., FY2015, FQ12015, CQ12015, etc.). The
absolutePeriodEnd X X valid values are:
• FQ
• FY
• CQ
This property applies to Credit Analytics Data (i.e., the Credit Indicators data
category). Indicates the start period of the period range for which value is to be
calculated for the mnemonic (e.g., FY2015, FQ12015, CQ12015, etc.). The
absolutePeriodStart X X X valid values are:
• FQ
• FY
• CQ
This property applies to Credit Analytics PaySense mnemonics. The valid
values are:
• DollarWeighted
• WithinTerms
adjustForPaymentDelay X X X • Delay1to30days
• Delay31to60days
• Delay61to90days
• Delay91daysAndAbove
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
The property allows users to select the metrics (PD/Score) in which they would
benchmarkOutput X like to see the underlying model values that are used in RiskGauge Score
calculations.
The valid values are:
businessEntityType X • Parent
• ParentSubsidiaries
When this property is specified, then the benchmark value will be calculated
only for companies with the size from the bucket specified (size is counted in
millions USD of revenue). If it is not specified, supplied benchmark value will be
returned.
The valid values (ranges) are:
• 0-5
• 5-10
CACompanySize X X X • 10-25
• 25-50
• 50-100
• 100-200
• 200-500
• 500-1000
• 1000-5000
• >=5000
This property is applicable to the Credit Health Panel subgroup in the Credit
Related Data dataset. Comma separated string specifying an identifier or list of
compareTo X X
identifiers to calculate the value of a given mnemonic so that comparisons can
be made.
This property applies to CIQ Financials and CIQ Estimates mnemonics. The
valid values are:
consolidatedFlag X X X • CON – Consolidated [default for Financials]
• PAR – Parent Only
• UNC – Unconsolidated
This property applies when requesting Detailed Estimates and Premium
contributorId X X X
Company Data Analyst coverage mnemonics.
The valid values are:
creditScale X X X • Local
• Global
This property applies to IQ mnemonics in the CIQ Financials and CIQ
Estimates mnemonics. If the currency is not the reported currency, this
currencyConversion
X X X parameter controls how the data should be currency converted. The valid
ModeId
values are:
• Historical
2 Last updated 7/11/2022
API Properties and Valid Values
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• SpotRate
The currency in which the financial data should be displayed. Monetary data will
currencyId X X X
be converted to this currency, if collected in a different currency.
This property applies to IQ mnemonics and works only with GDSPV and
GDSHV functions. Outputs additional data elements for the mnemonic being
enableMetadata X X requested. The valid values are:
• True
• False
This property should be used with startDate. It specifies the end date for which
endDate X X X X data is requested. If the endDate is not specified, the current date is considered
to be the endDate by default. The date format is mm/dd/yyyy.
This property is used for range functions and displays any number representing
endRank X X X
end rank. The valid values are numbers.
The valid values are:
endTerm X • 1MTH thru 12MTH (9MTH, 10MTH, etc.)
• 1YR thru 35YR (but increases over time e.g., 5YR, 6YR, etc.)
This property applies to CIQ Financials and Estimates mnemonics. The valid
values are:
filingMode X X X
• P – Period [default]
• F – Filing
Specifies the frequency of the requested data. The valid values are case
sensitive and include:
Non-IQ mnemonic calendar frequencies:
• D
• W
• M
• Q
• S
frequency X • A
Non-IQ mnemonic fiscal frequencies:
• FQ
• FS
• FA
IQ Mnemonic calendar frequencies:
• Daily
• Weekly
• Monthly
3 Last updated 7/11/2022
API Properties and Valid Values
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• Quarterly
• Yearly
This property applies only when requesting Key Development ID list
mnemonics. When requesting multiple filters, use comma separated values with
keyDevFilter X
no embedded white spaces (example: C1,T48,T50,T55). Please refer to the list
of Key Development Filters in the Key Developments user guide.
This property applies when requesting Credit Stats Direct Public Finance and
Financial Institution mnemonics using GDST. Limit should be used in
conjunction with the Frequency property. For example, if the Limit is ‘8’ and the
limit X
Frequency is ‘FQ’ (Fiscal Quarterly), the response will include time-series data
values for the eight most recent fiscal quarters. The value of the Limit should be
between 1 and 40.
This property will influence the header row of a GDSHE request to a specific
date or value depending on the user’s preference and requested mnemonic.
This property applies to IQ_ mnemonics. The default value is AsOfDate and can
be changed to any of the below fields:
Dates
• AsOfDate (default property for all mnemonics except Credit Analytics)
• CalendarQuarter
• CalendarYear
• EffectiveDate
• FilingDate
metaDataTag X • FiscalQuarter
• FiscalYear
• Month
• PeriodDate
• PricingDate
• ScoringDate (default property for Credit Analytics mnemonics)
• ScoringYear
• ValuationDate
Rank
• Rank
• ScoreRank
This property applies to Credit Analytics Data. The valid values are:
• CM
modelId X X X
• FN
• MS
4 Last updated 7/11/2022
API Properties and Valid Values
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• PS
• CM_EUR
• CM_JP
• CM_NA_APAC
• CM_AIRLINES
• CM_EM
• CM_FI_BANKS_EUR_NA
• CM_FI_BANKS_EM
• CM_FI_BANKS_OTHER
• CM_FI_INS_EUR_NA
• CM_FI_INS_NON_EUR_NON_NA
• PD_FN_BANKS_NA
• PD_FN_BANKS_NON_NA
• PD_MS_CORP
• PD_MS_FI_BANKS_NA
• PD_MS_FI_BANKS_NON_NA
• PD_MS_FI_DIV_FIN
• PD_MS_FI_INS
• PD_FN_PUB_CORPS_MANUFACTURING_NA
• PD_FN_PUB_CORPS_INFRASTRUCTURE_NA
• PD_FN_PUB_CORPS_SERVICES_NA
• PD_FN_PUB_CORPS_MANUFACTURING_NON_NA
• PD_FN_PUB_CORPS_INFRASTRUCTURE_NON_NA
• PD_FN_PUB_CORPS_SERVICES_NON_NA
• PD_FN_PRIV_CORPS_MANUFACTURING
• PD_FN_PRIV_CORPS_INFRASTRUCTURE
• PD_FN_PRIV_CORPS_SERVICES
This property applies to Ownership data. The valid values are:
ownershipType X X • Issue
• Summary
This property applies to Credit Analytics Data (i.e., the Credit Indicators data
category). The valid values are:
• NONE
• IQ_CM_ACID_TEST
• IQ_CM_ASSET_TURNS
PDType X X X • IQ_CM_BIC_RISK_SCORE
• IQ_CM_CASH_OPER_INT_COV
• IQ_CM_CASH_TO_DEBT
• IQ_CM_COMMON_EQUITY_TOTAL_ASSETS
• IQ_CM_CPI_YOY
• IQ_CM_CTRY_RISK_SCORE
• IQ_CM_CURR_LIAB_NET_WORTH
5 Last updated 7/11/2022
API Properties and Valid Values
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• IQ_CM_CURRENT_RATIO
• IQ_CM_DEBT_EQUITY
• IQ_CM_DEBT_REVENUE
• IQ_CM_DEPOSITS_GROWTH
• IQ_CM_EBIT_INT
• IQ_CM_EBIT_REVENUE
• IQ_CM_EBITDA_INT
• IQ_CM_EBIT_REVENUE
• IQ_CM_FFO_DEBT
• IQ_CM_FFO_INT_COV
• IQ_CM_EBT_INT
• IQ_CM_FOCF_DEBT
• IQ_CM_GEARING_RATIO
• IQ_CM_IICRS
• IQ_CM_LL_PROV_LOANS
• IQ_CM_LOANS_DEPOSITS
• IQ_CM_NET_OPER_INC_AFTER_LOAN_LOSS_REV
• IQ_CM_NI_TOTAL_REV
• IQ_CM_NON_PERF_ASSETS_TOTAL_ASSETS
• IQ_CM_OPER_CF_TOTAL_ASSETS
• IQ_CM_OPER_EXP_TOTAL_ASSETS
• IQ_CM_RE_DEBT_EQUITY
• IQ_CM_RETURN_CAPITAL
• IQ_CM_SALES_GROWTH
• IQ_CM_TIER_ONE_RATIO
• IQ_CM_TOTAL_ASSETS
• IQ_CM_TOTAL_EQUITY
• IQ_CM_TOTAL_EQUITY_TOTAL_ASSETS
• IQ_CM_SOV_SCORE
• IQ_CM_STANDALONE_SCORE
• IQ_CM_SOV_IMPL_1YR_PD
• IQ_CM_SOV_IMPL_3YR_PD
• IQ_CM_SOV_IMPL_5YR_PD
• IQ_CM_STANDALONE_IMPL_1YR_PD
• IQ_CM_STANDALONE_IMPL_3YR_PD
• IQ_CM_STANDALONE_IMPL_5YR_PD
• IQ_CM_PG_SOV_SCORE
• IQ_CM_PG_STANDALONE_SCORE
• IQ_CM_PG_SOV_IMPL_1YR_PD
• IQ_CM_PG_SOV_IMPL_3YR_PD
• IQ_CM_PG_SOV_IMPL_5YR_PD
• IQ_CM_PG_STANDALONE_IMPL_1YR_PD
• IQ_CM_PG_STANDALONE_IMPL_3YR_PD
• IQ_CM_PG_STANDALONE_IMPL_5YR_PD
• IQ_FN_SOV_IMPL_1YR_CREDIT_SCORE
• IQ_FN_STANDALONE_IMPL_1YR_CREDIT_SCORE
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• IQ_FN_STANDALONE_1YR_PD
• IQ_FN_SOV_1YR_PD
• IQ_FN_SOV_2YR_PD
• IQ_FN_SOV_3YR_PD
• IQ_FN_SOV_4YR_PD
• IQ_FN_SOV_5YR_PD
• IQ_FN_PG_SOV_IMPL_1YR_CREDIT_SCORE
• IQ_FN_PG_STANDALONE_IMPL_1YR_CREDIT_SCORE
• IQ_FN_PG_STANDALONE_1YR_PD
• IQ_FN_PG_SOV_1YR_PD
• IQ_FN_PG_SOV_2YR_PD
• IQ_FN_PG_SOV_3YR_PD
• IQ_FN_PG_SOV_4YR_PD
• IQ_FN_PG_SOV_5YR_PD
• IQ_FN_FINANCIAL_RISK_1YR_PD
• IQ_FN_BUSINESS_RISK_1YR_PD
• IQ_FN_ADJ_COMMON_EQ_LL_RESERVE_TOTAL_GROSS_LOANS
• IQ_FN_BANK_ECON_RISK_SCORE
• IQ_FN_BANK_IND_RISK_SCORE
• IQ_FN_CASH_ASSETS
• IQ_FN_CASH_CURR_LIAB
• IQ_FN_CASH_INT_COV
• IQ_FN_CASH_OPER_NI
• IQ_FN_CORPORATE_RISK_SCORE
• IQ_FN_CPI_YOY_PD
• IQ_FN_CTRY_RISK_SCORE
• IQ_FN_CURR_LIAB_NET_WORTH
• IQ_FN_DEBT_EQUITY
• IQ_FN_EBIT_INT
• IQ_FN_EBIT_REVENUES
• IQ_FN_EBIT_TOTAL_ASSETS
• IQ_FN_FFO_INT_COV
• IQ_FN_LL_PROV_GROSS_LOANS
• IQ_FN_NI_TOTAL_LIAB
• IQ_FN_NI_TOTAL_REVENUE
• IQ_FN_NON_INT_EXP_ADJ_ASSETS
• IQ_FN_PPE_TOTAL_ASSETS
• IQ_FN_RE_ADJ_COMMON_EQUITY
• IQ_FN_RE_TOTAL_ASSETS
• IQ_FN_RETURN_EQUITY
• IQ_FN_RETURN_NET_CAP_PROXY
• IQ_FN_RETURN_NET_CAPITAL
• IQ_FN_RETURN_TOTAL_ADJ_ASSETS
• IQ_FN_SALES_GROWTH
• IQ_FN_TIER_ONE_CAPITAL_RATIO
• IQ_FN_TOTAL_ADJ_ASSETS
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• IQ_FN_SALES_GROWTH
• IQ_FN_TIER_ONE_CAPITAL_RATIO
• IQ_FN_TOTAL_ADJ_ASSETS
• IQ_FN_TOTAL_ASSETS
• IQ_FN_TOTAL_EQUITY
• IQ_FN_TOTAL_EQUITY_TOTAL_ASSETS
• IQ_FN_TOTAL_REVENUE
• IQ_MS_SOV_IMPL_1YR_SCORE
• IQ_MS_STANDALONE_IMPL_1YR_SCORE
• IQ_MS_STANDALONE_1YR_PD
• IQ_MS_SOV_1YR_PD
• IQ_MS_SOV_2YR_PD
• IQ_MS_SOV_3YR_PD
• IQ_MS_SOV_4YR_PD
• IQ_MS_SOV_5YR_PD
• IQ_MS_SOV_1YR_PD_LOW_SENTIMENT
• IQ_MS_SOV_1YR_PD_NEUTRAL_SENTIMENT
• IQ_MS_SOV_1YR_PD_HIGH_SENTIMENT
• IQ_MS_STANDALONE_1YR_PD_LOW_SENTIMENT
• IQ_MS_STANDALONE_1YR_PD_NEUTRAL_SENTIMENT
• IQ_MS_STANDALONE_1YR_PD_HIGH_SENTIMENT
• IQ_MS_SOV_1YR_PD_MEAN_LOW_SENTIMENT
• IQ_MS_SOV_1YR_PD_MEAN_NEUTRAL_SENTIMENT
• IQ_MS_SOV_1YR_PD_MEAN_HIGH_SENTIMENT
• IQ_MS_STANDALONE_1YR_PD_MEAN_LOW_SENTIMENT
• IQ_MS_STANDALONE_1YR_PD_MEAN_NEUTRAL_SENTIMENT
• IQ_MS_STANDALONE_1YR_PD_MEAN_HIGH_SENTIMENT
• IQ_MS_SOV_180_DAY_MEAN
• IQ_MS_SOV_1SD
• IQ_MS_STANDALONE_180_DAY_MEAN
• IQ_MS_STANDALONE_1SD
• IQ_PS_TRADE_PAYMENT_SCORE,
• IQ_PS_EXPECTED_DAYS_OF_PAYMENT_DELAY
Relative: For retrieving data relative to a current period the functions accepts
• IQ_CH: Calendar Half
periodType X X X • IQ_CQ: Calendar Quarter
• IQ_CY: Calendar Year
• IQ_FH: Fiscal Half
• IQ_FQ: Fiscal Quarter
• IQ_FY: Fiscal Year
• IQ_LTM: Last 12 Months (default for IQ Financials)
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
• IQ_NTM: Next 12 Months (default for IQ Estimates)
• IQ_MONTH: Last Completed Month
• 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.
Absolute: For retrieving data within a specific date range the functions accepts
Start Period Date / End Period Date as inputs. Any expressions using Absolute
referencing can be modified to pull a different period by changing the existing
period reference.
• CQ (Example: CQ12011 = Calendar Quarter 1 2011)
• CY (Example: CY2011 = Calendar Year 2011)
• FQ (Example FQ12011 = Fiscal Quarter 1 2011
• FY (Example: FY2011 = Fiscal Year 2011)
• YTD (Example: YTD2011 = Year to Date 2011)
This property applies to Credit Analytics Data (i.e., the Credit Indicators data
PICSCode X X X category). Please refer to the List of Industry Identifiers available in the Credit
Analytics Data Guide.
This property applies to Credit Analytics Point-in-Time (PIT) adjustment
PITAdjustmentDate X mnemonics only. Specifies the date for a mnemonic. String with date in
MM/DD/YYYY format.
This property applies when requesting NAICS and SICS mnemonics. The valid
values are:
• True
primaryFlag X
• False
True - Data collected internally
False – Data sourced from third party
This property is used to retrieve the record at a specific position, with
rank X mnemonics that return multiple rows or "Ranks" of data. The valid values are
numbers.
This property applies to Corporate Yield Curve data. The valid values are:
• A
• AA
• AAA
• B
rating X X
• BB
• BBB
• CCC
• HY
• IG
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
This property applies to CIQ Financials and Estimates mnemonics.
The valid values are:
• O – Original version
• P – Preliminary Version
restatementTypeId X X • LC – Latest on Capital IQ [default]
• LFR – Latest fully reported version
• LRI – Latest reported instance
• LRP – Latest reported period
• CHP –For Credit Health Panel Mnemonics
This property applies to Detailed Ownership and Market Items mnemonics.
secondaryIdentifier X X X Any string representing the identifier (e.g., as company, trading item, etc.). For
example : IQ26977524
This property applies to Credit Analytics Expanded Probability of Default
metrics. The valid values are: 1,2,3,4,5, FullHistory. The property allows users
threshold X X
to check for PD fundamental PD values for the company within the selected
threshold limit.
This property applies to Corporate Yield Curve data. The valid values are:
• ALLCORP
• ConsumerDiscretionary
• ConsumerStaples
• Energy
• Financials
• HealthCare
sector X X
• Industrials
• InformationTechnology
• Materials
• NONFIN
• RealEstate
• TelecommunicationServices
• Utilities
This property is applicable when requesting CDS and Dealer Traded Pricing
mnemonics. It is mnemonic derived and not function derived. Valid values are:
seniority X X X X X • SEN (Seniority)
• SUB (Subordinated)
If not defined, SEN is used as the default for these mnemonics.
This property is applicable when requesting CDS and Dealer Traded Pricing
mnemonics. Valid values are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
snapType X X The following table lists the global CDS Snap types with their corresponding
snap times.
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
snapType Snap_date_time (EST) Comments
1(LON Close) ~12:00 For both CDS and BOND
2 (NY Close) ~17:00 For both CDS and BOND
3(TYO Close) ~05:00 For both CDS and BOND
4 ~04:00 For both CDS and BOND
5 ~06:00 For both CDS and BOND
6 ~07:00 For both CDS and BOND
7 ~08:00 For both CDS and BOND
8 ~09:00 For both CDS and BOND
9 ~10:00 For both CDS and BOND
10 ~11:00 For both CDS and BOND
11 ~13:00 For both CDS and BOND
12 ~14:00 For both CDS and BOND
13 ~15:00 For both CDS and BOND
14 ~16:00 For both CDS and BOND
Identifies the source of the data (i.e. S&P Capital IQ People Detail data). Below
are the supported values.
source X X • P - Proprietary data only
• C - S&P Capital IQ data only
• PC - Proprietary data initially, then S&P Capital IQ data
This property applies to non-IQ mnemonics; the corresponding property for IQ
mnemonics is asOfDate. This property, when used with range functions, works
with both IQ and Non-IQ mnemonics. The only exception is with GDSP
startDate X X X X function. When used with the point in time function (GDSP) for GDS
mnemonics, this property can be used to request data for a particular date. The
same functionality with GDSP function for IQ mnemonics can be achieved by
asOfDate property. The date format is mm/dd/yyyy.
This property specifies the starting point of the records for mnemonics that
startRank X X X
return multiple rows or "Ranks" of data. The valid values are numbers.
The valid values are:
startTerm X • 1MTH thru 12MTH (9MTH, 10MTH, etc.)
• 1YR thru 35YR (but increases over time e.g., 5YR, 6YR, etc.)
This property is specifically for Corporate Yield Curve Pricing mnemonics.
tenor X Below are the supported Tenor values that represent the period for which data
is required:
11 Last updated 7/11/2022
API Properties and Valid Values
Property GDSP GDST GDSHE GDSG GDSPV GDSHV Description and Valid Values
1M, 3M, 6M, 9M, 1Y, 2Y, 3Y, 4Y, 5Y, 6Y, 7Y, 8Y, 9Y, 10Y, 11Y, 12Y, 13Y, 14Y,
15Y, 16Y, 17Y, 18Y, 19Y, 20Y, 21Y, 22Y, 23Y, 24Y, 25Y, 26Y, 27Y, 28Y, 29Y,
30Y
The valid values are:
term X • 1MTH thru 12MTH (9MTH, 10MTH, etc.)
• 1YR thru 35YR (but increases over time e.g., 5YR, 6YR, etc.)
The valid values are:
termType X • YR
• MTH
This property applies to Credit Analytics Data. The valid version values are:
For CreditModel, V_3_0 applies to the latest recalibrated version and V_2_6 for
the previous version.
For the PD Fundamental and PD Market Signal models, V_2_0 applies to the
version X X X
latest recalibrated version and V_1_0 to the previous version.
The latest version models apply the recalibration metrics from May 2021. If a value
for property version is not specified, it will default to the earlier version.