OutputMetadataMessages
objectAll fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
typestring
codestring
investmentsarray[object]
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
messagestring
Example
OutputMetadata
objectAll fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
requestIdstring
timestring(date-time)read-only
portfolioDatestring
portfolioCurrencystring
messagesarray[object]
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
Example
OutputReturnIndex
objectAll fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
cumFairNavUnweightedDrinumber(double)
cumFairNavUnweightedDriDatestring
cumFairNavWeightedDrinumber(double)
cumFairNavWeightedDriDatestring
exParNavUnweightedDrinumber(double)
exParNavUnweightedDriDatestring
exParNavWeightedDrinumber(double)
exParNavWeightedDriDatestring
navUnweightedDrinumber(double)
navUnweightedDriDatestring
navWeightedDrinumber(double)
navWeightedDriDatestring
priceUnweightedDrinumber(double)
priceUnweightedDriDatestring
priceWeightedDrinumber(double)
priceWeightedDriDatestring
Example
OutputShareClassInformation
object * Additional properties are NOT allowed.
commonShareSubTypestring
Refers to the type of securities that can be found within the equity database. For the vast majority; this value will populate as null for regular common shares. For a minority of share classes; this will populate as either Participating Preferred; Closed-End Fund; Foreign Share; or Foreign Participated Preferred which reflects our limited coverage of these types of securities within our equity database.
conversionRationumber(double)
The relationship between the chosen share class and the primary share class
cusipstring
drRationumber(double)
The number of underlying common shares backing each depositary receipt (DR) traded.
exchangeCodestring
A symbol for the stock exchange name; usually consisting of 3 to 5 characters; examples include NYSE; NAS; LSE; OTCBB ($$$ is used for private/unlisted securities)
exchangeSubMarketGlobalIdstring
Indicates a different marketplace or the different market tiers within a stock exchange.
investmentIdstring
Morningstar Issuer Id/ Investment Id
investmentNamestring
Morningstar standard investment name
investmentPrimaryIssuerobject
* Additional properties are NOT allowed.
Show Child Parameters
shareClassDescriptionstring
investmentStatusinteger(int32)
0: obsolete1: active9: other
investmentTypestring
The abbreviation for investment type classifications: Equity (EQ); Depositary Receipt (DR); Preferred Equity (PE); Unlisted Equity (UE)
ipoDatestring
The initial day that the share begins trading on a public exchange
ipoOfferPricenumber(double)
Indicates the price at which an issuer sells its shares under an initial public offering (IPO). The offer price is set by the issuer and its underwriters.
ipoOfferPriceRangestring
The estimated offer price range (low-high) for a new IPO. The field should be used until the final IPO price becomes available; as populated in the data field IPO Offer Price.
isDrboolean
Indicates if the share class is a depositary receipt: TRUE denotes it is an ADR or GDR; otherwise FALSE
isinstring
isMainShareobject
* Additional properties are NOT allowed.
Show Child Parameters
isPrimaryPerformanceIdobject
* Additional properties are NOT allowed.
Show Child Parameters
marketSymbolstring
An arrangement of characters representing a particular security listed on an exchange or traded publicly generated and maintained by market data (also known as Realtime). For example; Morningstar’s market symbol is 126.1.MORN where 126 refers to Realtime exchange code for NASDAQ; 1 refers to security type equity; and the last set of characters refers to company’s actual symbol.
parValuenumber(double)
Nominal value of a security determined by the issuing company
performanceStatusobject
* Additional properties are NOT allowed.
Show Child Parameters
securityTypestring
Indicates security type classification at the share class level: Common Stock (ST00000001); Preferred Stock (ST00000002); Industry (ST00000003); Index (ST00000004); ETF (ST00000005); Closed-end Fund (ST00000006); Investment Trusts (ST00000007); Note (ST00000009); Warrant (ST00000008); Units (ST000000A1); Rights (ST000000B1); Unlisted Common (ST000000C1); Unlisted Preferred (ST000000C2)
sedolstring
The stock exchange daily official list (SEDOL) is a seven-character identification code assigned by the London Stock Exchange. For securities issued in the UK the Sedol may be converted to an ISIN.
segmentMicCodestring
Indicates the Exchange ISO Market Segment Identifier Code (MIC). Reference: https://www.iso20022.org/market-identifier-codes ($$$ is used for private/unlisted securities)
symbolstring
An arrangement of characters (often letters) representing a particular security listed on an exchange or otherwise traded publicly: Note that Morningstar’s multi-share class symbols will often contain a period within the symbol; e.g. BRK.B for Berkshire Hathaway Class B
tradingCurrencystring
3 Character ISO code of the currency that the exchange price is denominated in; i.e. the trading currency of the security
tradingStatusobject
* Additional properties are NOT allowed.
Show Child Parameters
underlyingDrIssuerIdstring
Example
ResponseListViews
objectResponse containing entitled view packages and their associated dataset viewIds.
* Additional properties are NOT allowed.
viewsarray[object]required
A view package and the dataset viewIds it contains.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
Example