Query entitled universe to retrieve investment metadata
Get Universe Entitlements
Retrieve the primary filters your account is entitled for.
| Scenario | Request Inputs |
|---|---|
| Get equities entitlements. | GET /investments |
| Get managed investments entitlements. | GET /investments?source=managedInvestments |
Get Custom Universe
Retrieve a custom universe in full.
| Scenario | Request Inputs |
|---|---|
| Get equities custom universe. | GET /investments?universe=MY_EQUITIES_ABC |
| Get managed investments custom universe. | GET /investments?source=managedInvestments&universe=MY_MANAGED_INVESTMENTS_XYZ |
Filter Equities
Further narrow a custom universe or filter full universe.
| Scenario | Request Inputs |
|---|---|
| Filter custom universe by primary filter. | GET /investments?exchangeCode=XPAR&universe=MY_EQUITIES_ABC |
| Filter custom universe by primary and secondary filter. | GET /investments?exchangeCode=XPAR&securityType=ST00000001&universe=MY_EQUITIES_ABC |
| Filter full universe by primary filter only. | GET /investments?exchangeCode=XPAR |
| Filter full universe by primary and 1 secondary filter. | GET /investments?exchangeCode=XPAR&securityType=ST00000001 |
| Filter full universe by primary and 2 secondary filters. | GET /investments?exchangeCode=XPAR&shareClassInformationInvestmentType=ST00000001&securityType=ST00000001 |
Filter Managed Investments
Further narrow a custom universe or filter full universe.
| Scenario | Request Inputs |
|---|---|
| Filter custom universe by a primary filter. | GET /investments?source=managedInvestments&domicileCode=USA&universe=MY_MANAGED_INVESTMENTS_XYZ |
Filter managed investments by a primary filter (countryAvailableForSaleCode) |
GET /investments?source=managedInvestments&countryAvailableForSaleCode=USA |
Filter managed investments by a primary filter (domicileCode) |
GET /investments?source=managedInvestments&domicileCode=USA |
Retrieve Results Using Pagination Tokens
Set pagination preferences in inital request and retrieve paginated results using tokens.
| Scenario | Request Inputs |
|---|---|
Pagination settings initial request (default pageSize). |
GET /investments?exchangeCode=XPAR |
Pagination settings subsequent requests (default pageSize). |
GET /investments?exchangeCode=XPAR&paginationTokenNext=CJjVEBoTOhE |
Pagination settings initial request (explicit pageSize). |
GET /investments?exchangeCode=XPAR&pageSize=25 |
Pagination settings subsequent requests (explicit pageSize). |
GET /investments?exchangeCode=XPAR&pageSize=25&paginationTokenNext=CJjVEBoTOhE |
Query Parameters
Filters results to a custom universe defined during implementation for the account.
Example:MY_UNIVERSE_321
Specifies the investment data type to query.
Allowed values:equitiesmanagedInvestments
Default:equities
Primary filter for equities. Filters results by exchange code.
Example:XPAR
Secondary filter for equities. Accepts:
ST00000001- Common StockST00000002- Preferred StockST00000003- IndustryST00000004- IndexST00000005- ETFST00000006- Closed-end FundST00000007- Investment TrustsST00000008- WarrantST00000009- NoteST000000A1- UnitsST000000B1- RightsST000000C1- Unlisted CommonST000000C2- Unlisted Preferred
Allowed values:ST00000001ST00000002ST00000003ST00000004ST00000005ST00000006ST00000007ST00000009ST00000008ST000000A1ST000000B1ST000000C1ST000000C2
Example:ST00000001
Primary filter for managed investments. Accepts 3-character ISO 3166-1 country codes.
Example:AUS
Primary filter for managed investments. Accepts 3-character ISO 3166-1 country codes.
Example:AUS
Secondary filter for equities.
Accepts:
EQ- EquityDR- Depository ReceiptPE- Preferred EquityUE- Unlisted Equity
Allowed values:EQDRPEUE
Example:EQ
Specifies the token to fetch the next page of results.
Example:CJ2aBBoROg81YmFuYyBzcGxpdCBpbmMaDDoKMHAwMDAwbTJkaiIMOgowUDAwMDBNMkRK
Specifies the token to fetch the previous page of results.
Example:CJ2aBBoROg81YmFuYyBzcGxpdCBpbmMaDDoKMHAwMDAwbTJkaiIMOgowUDAwMDBNMkRK
Specifies the number of records per page.
Default:50
>= 1<= 50
Example:25
Response
application/json
Response
200: OK
ResponseInvestments
Response containing investment results and metadata.
Investment entry returned as part of the universe lookup.
Show Child Parameters
Show Child Parameters
Authentication
Query Parameters
DataModelBasicReference
objectShow Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
DataModelCompanyInformation
objectShow Child Parameters
An acronym for North American Industry Classification System (NAICS) specific to Canada; a 6-digit numerical classification assigned to individual companies. NAICS was developed jointly by the U.S.; Canada; and Mexico to provide new comparability in statistics about business activity across North America. It was intended to replace the U.S. Standard Industrial Classification (SIC) system. The initial SIC and NAICS listed is the Primary code based on revenue generation; followed by Secondary SIC and NAICS when applicable. Both SIC and NAICS are manually collected and assigned.
Show Child Parameters
Show Child Parameters
The upcoming expected year end for the company; it is calculated based on the current year end (from latest available annual report) + 1 year
Show Child Parameters
Show Child Parameters
The effective date when the Morningstar Industry Classification is updated for the company
This data point identifies two different processes a company can take to raise capital by listing shares on a public exchange; Initial public offering (Traditional IPO) and Direct Listing. IPO is the most common and traditional route; in which new shares are created; underwritten; and sold to the public. In a Direct Listing; no new shares are created; and only existing outstanding shares are sold with no underwriters involved. Traditional IPO and Direct Listing are the 2 types available starting in September 2021. For historical data prior to September 2021; Traditional IPO is not available; the 2 possible values prior to September 2021 are Null and Direct Listing.
Show Child Parameters
An acronym for International Standard Industrial Classification (ISIC); which was developed by the United Nations; and is the international reference classification of productive activities. Its main purpose is to provide a set of activity categories that can be utilized for the collection and reporting of statistics according to such activities. The majority of countries around the world have used ISIC as their national activity classification or have developed national classifications derived from ISIC.
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
The full name of the registrant as specified in its charter; and most often found on the front cover of the 10K/10Q/20F filings or annual report
3-character language code for the foreign legal name if/when applicable
The Legal Entity Identifier (LEI) is a 20-character; alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO). It connects to key reference information that enables clear and unique identification of legal entities participating in financial transactions.
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
NACE is a European standard classification of economic activities maintained by Eurostat that is similar to SIC and NAICS in North America. The NACE code is 5 characters long; is arranged in the following format 00.00 and provides the framework for collecting and presenting a large range of statistical data according to economic activity. The use of NACE is mandatory within the European Statistical System.
An acronym for North American Industry Classification System (NAICS); a 6-digit numerical classification assigned to individual companies. NAICS was developed jointly by the U.S.; Canada; and Mexico to provide new comparability in statistics about business activity across North America. It was intended to replace the U.S. Standard Industrial Classification (SIC) system. The initial SIC and NAICS listed is the Primary code based on revenue generation; followed by Secondary SIC and NAICS when applicable. Both SIC and NAICS are manually collected and assigned.
Show Child Parameters
25-character max abbreviated name of the firm: In most cases; the short name will simply be the Legal Name less the Corporation; Corp.; Inc.; Incorporated; etc.
An acronym for Standard Industrial Classification System (SIC); it is a system for classifying a business according to economic activity
Standard name for the entity
Show Child Parameters
An acronym for North American Industry Classification System (NAICS) specific to the United States; a 6-digit numerical classification assigned to individual companies. NAICS was developed jointly by the U.S.; Canada; and Mexico to provide new comparability in statistics about business activity across North America. It was intended to replace the U.S. Standard Industrial Classification (SIC) system. The initial SIC and NAICS listed is the Primary code based on revenue generation; followed by Secondary SIC and NAICS when applicable. Both SIC and NAICS are manually collected and assigned.
Indicates website address of company’s contact information
The year a company was founded
DataModelDelistInformation
objectThe effective date on which a security was delisted from an exchange
DataModelShareClassInformation
objectRefers 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.
The relationship between the chosen share class and the primary share class
Show Child Parameters
Show Child Parameters
The number of underlying common shares backing each depositary receipt (DR) traded.
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)
Indicates a different marketplace or the different market tiers within a stock exchange.
Morningstar Issuer Id/ Investment Id
Morningstar standard investment name
Show Child Parameters
0: obsolete1: active9: other
The abbreviation for investment type classifications: Equity (EQ); Depositary Receipt (DR); Preferred Equity (PE); Unlisted Equity (UE)
The initial day that the share begins trading on a public exchange
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.
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.
Indicates if the share class is a depositary receipt: TRUE denotes it is an ADR or GDR; otherwise FALSE
Show Child Parameters
Show Child Parameters
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.
Nominal value of a security determined by the issuing company
Show Child Parameters
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)
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.
Indicates the Exchange ISO Market Segment Identifier Code (MIC). Reference: https://www.iso20022.org/market-identifier-codes ($$$ is used for private/unlisted securities)
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
3 Character ISO code of the currency that the exchange price is denominated in; i.e. the trading currency of the security