Investments Universe

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
get

Query Parameters

universestring

Filters results to a custom universe defined during implementation for the account.

Example:MY_UNIVERSE_321

sourcestring

Specifies the investment data type to query.

Allowed values:equitiesmanagedInvestments

Default:equities

exchangeCodestring

Primary filter for equities. Filters results by exchange code.

Example:XPAR

securityTypestring

Secondary filter for equities. Accepts:

  • ST00000001 - Common Stock
  • ST00000002 - Preferred Stock
  • ST00000003 - Industry
  • ST00000004 - Index
  • ST00000005 - ETF
  • ST00000006 - Closed-end Fund
  • ST00000007 - Investment Trusts
  • ST00000008 - Warrant
  • ST00000009 - Note
  • ST000000A1 - Units
  • ST000000B1 - Rights
  • ST000000C1 - Unlisted Common
  • ST000000C2 - Unlisted Preferred

Allowed values:ST00000001ST00000002ST00000003ST00000004ST00000005ST00000006ST00000007ST00000009ST00000008ST000000A1ST000000B1ST000000C1ST000000C2

Example:ST00000001

countryAvailableForSaleCodestring

Primary filter for managed investments. Accepts 3-character ISO 3166-1 country codes.

Example:AUS

domicileCodestring

Primary filter for managed investments. Accepts 3-character ISO 3166-1 country codes.

Example:AUS

shareClassInformationInvestmentTypestring

Secondary filter for equities.

Accepts:

  • EQ - Equity
  • DR - Depository Receipt
  • PE - Preferred Equity
  • UE - Unlisted Equity

Allowed values:EQDRPEUE

Example:EQ

paginationTokenNextstring

Specifies the token to fetch the next page of results.

Example:CJ2aBBoROg81YmFuYyBzcGxpdCBpbmMaDDoKMHAwMDAwbTJkaiIMOgowUDAwMDBNMkRK

paginationTokenPreviousstring

Specifies the token to fetch the previous page of results.

Example:CJ2aBBoROg81YmFuYyBzcGxpdCBpbmMaDDoKMHAwMDAwbTJkaiIMOgowUDAwMDBNMkRK

pageSizeinteger(int32)

Specifies the number of records per page.

Default:50

>= 1<= 50

Example:25

Response

application/json

200: OK

ResponseInvestments

Response containing investment results and metadata.

investmentsarray[object]required

Investment entry returned as part of the universe lookup.

* Additional properties are allowed.
Show Child Parameters
metadataobjectrequired
Show Child Parameters
get/direct-web-services/v1/investments
 
application/json

DataModelBasicReference

object
* Additional properties are NOT allowed.
assetsUnderAdvisementDatestring
associatedShareClassstring
baseCurrencyobject
* Additional properties are NOT allowed.
Show Child Parameters
baseUnitnumber(double)
brandingCompanyAsOfDatestring
brandingNamestring
brandingNameIdstring
caFundCodestring
countryAfsPerformanceLevelarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
countryAvailableForSalearray[object]
* Additional properties are NOT allowed.
Show Child Parameters
countryRegisteredForSaleobject
* Additional properties are NOT allowed.
Show Child Parameters
custodianFeenumber(double)
custodianFeeAmountCninteger(int32)
delistingDatestring
domicileobject
* Additional properties are NOT allowed.
Show Child Parameters
domicileCountryobject
* Additional properties are NOT allowed.
Show Child Parameters
externalManagementCompanystring
firmLegalStructureobject
* Additional properties are NOT allowed.
Show Child Parameters
firmNamestring
firmNameIdstring
firmTypeobject
* Additional properties are NOT allowed.
Show Child Parameters
fundCodestring
fundidstring
fundLegalNamestring
fundLegalStructureobject
* Additional properties are NOT allowed.
Show Child Parameters
fundStandardNamestring
germanWknstring
grossAssetsCurrencyobject
* Additional properties are NOT allowed.
Show Child Parameters
iaPrimaryShareClassobject
* Additional properties are NOT allowed.
Show Child Parameters
inceptionDatestring
inceptionDateOfFundSOldestShareClassstring
indexFamilyIdstring
indexFamilyNamestring
investmentTypeobject
* Additional properties are NOT allowed.
Show Child Parameters
ipoAssetRaisednumber(double)
ipoEndDatestring
ipoStartDatestring
isinstring
itaCodestring
latestAccountingDatestring
legalNamestring
lifeTriggerEventDatestring
lifeTriggerEventTypeobject
* Additional properties are NOT allowed.
Show Child Parameters
listingDatestring
localFirmNameJpstring
localFirmNameKrstring
localFirmShortNameJpstring
localFundLegalNameKrstring
localLegalNameJpstring
localLegalNameKrstring
localNameAfrikaansstring
localNameCnstring
localNameHebrewstring
localNameHkstring
localNameJpstring
localNameKrstring
localNameSgstring
localNameThaistring
localNameTwstring
masterFundidstring
masterPortfolioIdinteger(int32)
maximumSwingFactorDownwardsnumber(double)
maximumSwingFactorUpwardsnumber(double)
mexCodestring
namestring
nameOfFundSOldestShareClassstring
obsoleteDatestring
obsoleteTypeobject
* Additional properties are NOT allowed.
Show Child Parameters
oldestShareClassobject
* Additional properties are NOT allowed.
Show Child Parameters
operationsDataReadyobject
* Additional properties are NOT allowed.
Show Child Parameters
performanceDataReadyobject
* Additional properties are NOT allowed.
Show Child Parameters
performanceIdstring
performanceStartDatestring
pieConversionDatestring
portfolioCurrencyobject
* Additional properties are NOT allowed.
Show Child Parameters
portfolioDataReadyobject
* Additional properties are NOT allowed.
Show Child Parameters
portfolioDatestring
previousNameOfFirmstring
priceDataReadyobject
* Additional properties are NOT allowed.
Show Child Parameters
primaryShareobject
* Additional properties are NOT allowed.
Show Child Parameters
priorFirmNamestring
productFocusobject
* Additional properties are NOT allowed.
Show Child Parameters
regionOfSaleobject
* Additional properties are NOT allowed.
Show Child Parameters
registrationDateTwstring
restructureDatestring
secidForImportstring
seriesNamestring
shareClassTypeobject
* Additional properties are NOT allowed.
Show Child Parameters
sharesPercDateCnstring
statusobject
* Additional properties are NOT allowed.
Show Child Parameters
swissValorstring
tickerstring
tickerOfFundSOldestShareClassstring
underlyingFundInceptionDatestring
underlyingFundNamestring
underlyingFundSecidstring
usHeadquartersstring
valuationCountryobject
* Additional properties are NOT allowed.
Show Child Parameters
virtualClassobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

DataModelCompanyInformation

object
* Additional properties are NOT allowed.
businessCountryCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
canNaicsinteger(int64)

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.

cikstring
companyStatusobject
* Additional properties are NOT allowed.
Show Child Parameters
domicileCountryCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
expectedFiscalYearEndstring

The upcoming expected year end for the company; it is calculated based on the current year end (from latest available annual report) + 1 year

fiscalYearEndobject
* Additional properties are NOT allowed.
Show Child Parameters
globalTemplateIndustryTemplateCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
industryClassificationEffectiveDatestring

The effective date when the Morningstar Industry Classification is updated for the company

ipoTypestring

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.

isBusinessDevelopmentCompanyobject
* Additional properties are NOT allowed.
Show Child Parameters
isicstring

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.

isLimitedLiabilityCompanyobject
* Additional properties are NOT allowed.
Show Child Parameters
isLimitedPartnershipobject
* Additional properties are NOT allowed.
Show Child Parameters
isMasterLimitedPartnershipobject
* Additional properties are NOT allowed.
Show Child Parameters
isReitobject
* Additional properties are NOT allowed.
Show Child Parameters
isShellCompanyobject
* Additional properties are NOT allowed.
Show Child Parameters
isSpecialPurposeAcquisitionCompanyobject
* Additional properties are NOT allowed.
Show Child Parameters
legalNamestring

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

legalNameLanguageCodestring

3-character language code for the foreign legal name if/when applicable

leistring

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.

morningstarIndustryCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
morningstarIndustryGroupCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
morningstarSectorCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
morningstarSuperSectorCodeobject
* Additional properties are NOT allowed.
Show Child Parameters
nacestring

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.

naicsinteger(int64)

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.

operationStatusobject
* Additional properties are NOT allowed.
Show Child Parameters
shortNamestring

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.

sicinteger(int64)

An acronym for Standard Industrial Classification System (SIC); it is a system for classifying a business according to economic activity

standardNamestring

Standard name for the entity

stateOrCountryOfIncorporationobject
* Additional properties are NOT allowed.
Show Child Parameters
usaNaicsinteger(int64)

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.

webAddressstring

Indicates website address of company’s contact information

yearOfEstablishmentinteger(int64)

The year a company was founded

Example

DataModelDelistInformation

object
* Additional properties are NOT allowed.
delistingDatestring

The effective date on which a security was delisted from an exchange

Example