Get token
Exchanges your Client ID and Client Secret for a signed JWT bearer token.
Send your credentials as a Base64-encoded clientId:clientSecret string in the Authorization header. Use the returned access_token as a Bearer token on all other endpoints in this API.
post
Response
application/json
Response
application/json
200: OK
OutputToken
A successful authentication response containing a JWT bearer token.
access_tokenstringrequired
The signed JWT to use as a Bearer token in subsequent authenticated requests.
Example:eyJhbGciOiJ example
expires_inintegerrequired
The number of seconds until the token expires. After expiry, request a new token.
Example:3599
token_typestringrequired
The token type. Always Bearer.
Example:Bearer
post/token/oauth
Authentication
application/json
Investment List
Retrieve investment list.
post
Body
application/json
Body
application/json
RequestRetrieveInvestmentList
* Additional properties are NOT allowed.
datapointsarray[string]required
Lists data points to return. Retrieve valid values programmatically via GET /direct-web-services/v1/investment-list/data-points, or browse the full reference in the data dictionary.
<= 50 items
Example:["companyInformation.cik","companyInformation.legalName","companyInformation.morningstarSectorCode","balanceSheet.totalAssetsValueFY","basicReference.isin"]
investmentsarray[object]required
Investment to query. Investment look up is supported.
* Additional properties are NOT allowed.
Show Child Parameters
sortarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
languageIdstring
Gets or sets the language for the investment list results.
currencyIdstring
Gets or sets the currency for the investment list results.
Response
application/json
Response
application/json
OK
ResponseRetireveInvestmentList
Response including results and metadata.
* Additional properties are NOT allowed.
investmentsarray[object]read-only
Output investment.
Show Child Parameters
metadataobjectread-only
Metadata returned in response including information about input investment identifiers for which no results were found.
* Additional properties are NOT allowed.
Show Child Parameters
post/direct-web-services/v1/investment-list
Authentication
Body
{
"investments": [
{
"id": "0P000000YF"
},
{
"id": "0P000000YD"
},
{
"id": "0P000000YB"
},
{
"id": "0P000000YA"
},
{
"id": "0P000000W8"
}
],
"dataPoints": [
"basicReference.name",
"basicReference.ticker",
"instrumentIdentifiers.isin",
"reference.assetType",
"reference.currency",
"dailyReturnsMostRecent.returnDateDaily",
"dailyReturnsMostRecent.totalRet1DayDaily",
"dailyReturnsMostRecent.totalRet1WkDaily",
"dailyReturnsMostRecent.totalRet1MoDaily",
"dailyReturnsMostRecent.totalRetYtdDaily",
"dailyReturnsMostRecent.totalRet1YrDaily",
"trailingReturn.trailingReturnAsOfDate",
"trailingReturn.trailing1MonthReturn",
"trailingReturn.trailing3MonthReturn",
"trailingReturn.trailing6MonthReturn",
"trailingReturn.trailing1YearReturn",
"trailingReturn.trailing3YearReturn",
"trailingReturn.trailing5YearReturn",
"monthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.returnDateMoEnd",
"monthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRet1YrMoEnd",
"monthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd3YrMoEnd",
"monthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd5YrMoEnd"
]
}
application/json
Data Points
List available data points.
get
Response
application/json
Response
application/json
OK
ResponseGetDataPoints
Metadata for an available data point.
* Additional properties are NOT allowed.
namestringrequired
The data point identifier in dot-notation, used as the value in the dataPoints request array.
Allowed values:annualReportFeesAndFinancialsMostRecent.totalExpenseRatioannualReturnsHistorical.annualRet2020annualReturnsHistorical.annualRet2021annualReturnsHistorical.annualRet2022annualReturnsHistorical.annualRet2023annualReturnsHistorical.annualRet2024assetAllocationBreakdown.assetAllocBondPercNetassetAllocationBreakdown.assetAllocCashPercNetassetAllocationBreakdown.assetAllocEquityPercNetassetAllocationBreakdown.assetAllocOtherPercNetbasicReference.baseCurrencybasicReference.countryAvailableForSalebasicReference.domicilebasicReference.firmNamebasicReference.fundCodebasicReference.fundidbasicReference.fundLegalNamebasicReference.inceptionDatebasicReference.investmentTypebasicReference.isinbasicReference.legalNamebasicReference.namebasicReference.portfolioDatebasicReference.primarySharebasicReference.shareClassTypebasicReference.tickerbestAndWorstRollingReturns.best3MoAsOfDateQtrEndbestAndWorstRollingReturns.best3MoRetInceptionQtrEndbestAndWorstRollingReturns.worst3MoAsOfDateQtrEndbestAndWorstRollingReturns.worst3MoRetInceptionQtrEndcompanyGrade.growthGradecompanyGrade.profitabilityGradecompanyInformation.cikcompanyInformation.companyIdcompanyInformation.companyStatuscompanyInformation.domicileCountryCodecompanyInformation.globalTemplateIndustryTemplateCodecompanyInformation.legalNamecompanyInformation.legalNameLanguageCodecompanyInformation.leicompanyInformation.morningstarIndustryCodecompanyInformation.morningstarIndustryGroupCodecompanyInformation.morningstarSectorCodecompanyInformation.operationStatuscompanyInformation.shortNamecompanyInformation.standardNamecompanyInformation.webAddresscountryAndRegionalExposureBreakdown.equityRegionEmergingPercLongRescaledcountryAndRegionalExposureBreakdown.equityRegionGreaterAsiaPercLongRescaledcountryAndRegionalExposureBreakdown.equityRegionGreaterEuropePercLongRescaledcountryAndRegionalExposureBreakdown.equityRegionUnitedStatesPercLongRescaleddailyDividendResidualRiskAndReturnSensitivity.beta1260DaydailyReturnsMostRecent.returnDateDailydailyReturnsMostRecent.totalRet1DayDailydailyReturnsMostRecent.totalRet1MoDailydailyReturnsMostRecent.totalRet1WkDailydailyReturnsMostRecent.totalRet1YrDailydailyReturnsMostRecent.totalRet3MoDailydailyReturnsMostRecent.totalRet6MoDailydailyReturnsMostRecent.totalRetAnnlzd10YrDailydailyReturnsMostRecent.totalRetAnnlzd3YrDailydailyReturnsMostRecent.totalRetAnnlzd5YrDailydailyReturnsMostRecent.totalRetYtdDailydailyStandardDeviation.arithmeticMean1008DaydailyStandardDeviation.arithmeticMean1260DaydailyStandardDeviation.arithmeticMean2520DaydailyStandardDeviation.arithmeticMean252DaydailyStandardDeviation.arithmeticMean504DaydailyStandardDeviation.arithmeticMean756DaydailyStandardDeviation.dailyStandardDeviationAsOfDatedailyStandardDeviation.standardDeviation1008DaydailyStandardDeviation.standardDeviation1260DaydailyStandardDeviation.standardDeviation2520DaydailyStandardDeviation.standardDeviation252DaydailyStandardDeviation.standardDeviation504DaydailyStandardDeviation.standardDeviation756DaydelistInformation.delistingDatederivedStatisticsFromIndexLevelsTimeSeries.averageAnnualReportNetExpenseRatioderivedStatsIEMptCurrent.sharpeRatio3YrMoEndderivedStatsIEMptCurrent.stdDev3YrMoEnddividendResidualRiskAndReturnSensitivity.alpha12MonthdividendResidualRiskAndReturnSensitivity.alpha36MonthdividendResidualRiskAndReturnSensitivity.alpha60MonthdividendResidualRiskAndReturnSensitivity.beta12MonthdividendResidualRiskAndReturnSensitivity.beta36MonthdividendResidualRiskAndReturnSensitivity.beta60MonthdividendResidualRiskAndReturnSensitivity.rSquare12MonthdividendResidualRiskAndReturnSensitivity.rSquare36MonthdividendResidualRiskAndReturnSensitivity.rSquare60MonthenterpriseValueCalculations.cashReturnenterpriseValueCalculations.enterpriseValueenterpriseValueCalculations.enterpriseValueToEbitdaRatioenterpriseValueCalculations.enterpriseValueToEbitRatioenterpriseValueCalculations.enterpriseValueToFreeCashFlowRatioenterpriseValueCalculations.enterpriseValueToRevenueRatioenterpriseValueCalculations.totalDebtToEnterpriseValueequityPortfolioStatistics.averageMarketCapMilLongequityPortfolioStatistics.equityStyleFactorDivYldLongequityPortfolioStatistics.numberOfHoldingsequityPortfolioStatistics.percAssetInTop10HoldingsequityPortfolioStatistics.porbRatioTtmLongequityPortfolioStatistics.poreRatioTtmLongequityPortfolioStatistics.roePercTtmLongequityResearchRatingsMostRecent.priceOrFairValueequityResearchRatingsMostRecent.stockCapitalAllocationRatingesgFundLevelCarbonRisk.portfolioCarbonRiskScoreesgFundLevelRatingsHistorical.morningstarSustainabilityRatingesgFundLevelRatingsHistorical.portfolioCorporateSustainabilityScoreesgFundLevelRatingsHistorical.portfolioEnvironmentalRiskScoreesgFundLevelRatingsHistorical.portfolioGovernanceRiskScoreesgFundLevelRatingsHistorical.portfolioSocialRiskScoreesgFundLevelRatingsMostRecent.sustainabilityRatingDatefeeLevelRanks.morningstarFeeLevelBroadfinancialHealthGrade.financialHealthGradeValuefinancialHealthGrade.probabilityOfDefaultfixedIncomePortfolioStatisticsSurveyedAnalytics.averageCreditQualityfixedIncomePortfolioStatisticsSurveyedAnalytics.averageEffDurationSurveyfixedIncomePortfolioStatisticsSurveyedAnalytics.averageYtmSurveyfundAttributes.activelyManagedfundAttributes.fundOfFundsfundAttributes.indexFundfundAttributes.openForInvestmentindexTick.indexPriceindexTick.indexPricePublicationTimeinstrumentIdentifiers.localCodeinstrumentIdentifiers.vendorTickerSymbolinvestmentBasicDetails.advisorinvestmentBasicDetails.distributorinvestmentBasicDetails.exchangeinvestmentBasicDetails.exchangeCountryinvestmentBasicDetails.firmCountryinvestmentBasicDetails.managementCompanyinvestmentBasicDetails.primaryProspectusBenchmarkinvestmentBasicDetails.primaryProspectusBenchmarkIdinvestmentBasicDetails.subadvisormanagerBioAndDetailsMostRecent.managerNamemanagerBioAndDetailsMostRecent.managerTenureAveragemanagerBioAndDetailsMostRecent.managerTenureLongestmarketCapital.asOfDatemarketCapital.companyLevelMarketCapitalmarketCapital.currencyCodemarketCapital.shareLevelMarketCapitalmarketCapitalBreakdown.marketCapGiantPercLongRescaledmarketCapitalBreakdown.marketCapLargePercLongRescaledmarketCapitalBreakdown.marketCapMidPercLongRescaledmarketCapitalBreakdown.marketCapSmallPercLongRescaledmarketReturn.asOfDatemarketReturn.nonDividendTotalReturnMonthToDatemarketReturn.nonDividendTotalReturnOneDaymarketReturn.totalGrossedUpReturnDateToDatemarketReturn.totalGrossedUpReturnMonthToDatemarketReturn.totalGrossedUpReturnQuarterToDatemarketReturn.totalGrossedUpReturnWeekToDatemarketReturn.totalGrossedUpReturnYearToDatemarketReturn.totalReturnMonthToDatemarketReturn.totalReturnOneDaymarketReturn.totalReturnQuarterToDatemarketReturn.totalReturnWeekToDatemarketReturn.totalReturnYearToDatemetadata.priceFrequencyFlagmonthEndReturnStatistics.asOfDatemonthEndReturnStatistics.best3MonthTotalReturnOverPast120MonthsmonthEndReturnStatistics.best3MonthTotalReturnOverPast12MonthsmonthEndReturnStatistics.best3MonthTotalReturnOverPast36MonthsmonthEndReturnStatistics.best3MonthTotalReturnOverPast60MonthsmonthEndReturnStatistics.worst3MonthTotalReturnOverPast120MonthsmonthEndReturnStatistics.worst3MonthTotalReturnOverPast12MonthsmonthEndReturnStatistics.worst3MonthTotalReturnOverPast36MonthsmonthEndReturnStatistics.worst3MonthTotalReturnOverPast60MonthsmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.returnDateMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRet1MoMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRet1YrMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRet1YrQtrEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRet3MoMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRet6MoMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd10YrMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd10YrQtrEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd3YrMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd3YrQtrEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd5YrMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetAnnlzd5YrQtrEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetInceptionMoEndmonthEndTrailingPerformanceMonthEndAndQuarterEndMostRecent.totalRetYtdMoEndmonthlyStandardDeviation.arithmeticMean120MonthmonthlyStandardDeviation.arithmeticMean12MonthmonthlyStandardDeviation.arithmeticMean24MonthmonthlyStandardDeviation.arithmeticMean36MonthmonthlyStandardDeviation.arithmeticMean48MonthmonthlyStandardDeviation.arithmeticMean60MonthmonthlyStandardDeviation.asOfDatemonthlyStandardDeviation.standardDeviation120MonthmonthlyStandardDeviation.standardDeviation12MonthmonthlyStandardDeviation.standardDeviation24MonthmonthlyStandardDeviation.standardDeviation36MonthmonthlyStandardDeviation.standardDeviation48MonthmonthlyStandardDeviation.standardDeviation60MonthmorningstarCategory.globalBroadCategoryGroupmorningstarCategory.globalCategorymorningstarCategory.morningstarCategoryIdmorningstarEquitySectorsBreakdown.equityEconSectorConsumerCyclicalPercLongRescaledmorningstarEquitySectorsBreakdown.equityEconSectorConsumerDefensivePercLongRescaledmorningstarEquitySectorsBreakdown.equityEconSectorEnergyPercLongRescaledmorningstarEquitySectorsBreakdown.equityEconSectorFinancialServicesPercLongRescaledmorningstarEquitySectorsBreakdown.equityEconSectorHealthcarePercLongRescaledmorningstarEquitySectorsBreakdown.equityEconSectorTechnologyPercLongRescaledmorningstarMedalistRatingMostRecent.morningstarMedalistRatingmorningstarMedalistRatingMostRecent.morningstarMedalistRatingDatemorningstarMedalistRatingMostRecent.morningstarMedalistRatingParentPillarmorningstarMedalistRatingMostRecent.morningstarMedalistRatingPeoplePillarmorningstarMedalistRatingMostRecent.morningstarMedalistRatingProcessPillarmorningstarPortfolioRiskScore.portfolioRiskScoremorningstarPortfolioRiskScore.portfolioRiskScoreDatemorningstarRatingMostRecent.morningstarRating10YrmorningstarRatingMostRecent.morningstarRating3YrmorningstarRatingMostRecent.morningstarRating5YrmorningstarRatingMostRecent.morningstarRatingOverallmorningstarRatingMostRecent.ratingDatemorningstarStyleBox.equityStyleBoxLongmorningstarStyleBox.sizeScoreLongmorningstarStyleBox.valueGrowthScoreLongmsciCountryClassification.msciCountrynetAssetsMonthEndMostRecent.firmTotalAssetsnetAssetsMonthEndMostRecent.fundSizenetAssetsMonthEndMostRecent.netAssetsDatenonDividendResidualRiskAndReturnSensitivity.nonDividendBeta36MonthnonDividendResidualRiskAndReturnSensitivity.nonDividendRSquare36MonthperformanceRanks.bearMarketRankPercMoEndperformanceRanks.totalRetPercRankCat10YrMoEndperformanceRanks.totalRetPercRankCat1YrMoEndperformanceRanks.totalRetPercRankCat3YrMoEndperformanceRanks.totalRetPercRankCat5YrMoEndperformanceRanks.totalRetPercRankCatYtdMoEndperformanceStatistics.midNetChangeperformanceStatistics.midPercentChangepriceMultiples.capeRatiopriceMultiples.normalizedPegRatiopriceMultiples.normalizedPriceToEarningsRatiopriceMultiples.normalizedPriceToEarningsRatioNormalizedProfitabilityMetricspriceMultiples.normalizedPriceToEbitdaRatiopriceMultiples.normalizedPriceToEbitdarRatiopriceMultiples.normalizedPriceToEbitRatiopriceMultiples.priceEarningsToGrowthRatiopriceMultiples.priceToAdjustedFundsFromOperationspriceMultiples.priceToBookRatiopriceMultiples.priceToCashFlowRatiopriceMultiples.priceToCashRatiopriceMultiples.priceToEarningsRatiopriceMultiples.priceToEbitdaRatiopriceMultiples.priceToEbitdarRatiopriceMultiples.priceToEbitRatiopriceMultiples.priceToFreeCashFlowRatiopriceMultiples.priceToFundsFromOperationspriceMultiples.priceToSalesRatiopriceMultiples.priceToTangibleBookValueRatiopriceMultiples.privateEps10priceMultiples.privateNetEarnings10priceMultiplestatistics.asOfDatepricesMostRecent.avgDailyVolume1MopricesMostRecent.avgDailyVolume1YrpricesMostRecent.avgDailyVolume3MopricesMostRecent.below52WkHighPercpricesMostRecent.datePrice52WkHighpricesMostRecent.datePrice52WkLowpricesMostRecent.lastClosepricesMostRecent.monthEndPricepricesMostRecent.monthEndPriceDatepricesMostRecent.navMoEndpricesMostRecent.price52WkHighpricesMostRecent.price52WkLowpriceYields.earningsYieldprospectusFees.managementFeeprospectusFees.maxFrontLoadprospectusFees.prospectusGrossExpenseRatioprospectusFees.prospectusNetExpenseRatiopurchaseDetails.closedToAllInvpurchaseDetails.minimumAdditionalPurchasepurchaseDetails.minimumInvestmentBaseCurrencypurchaseDetails.shareClassClosedToNewInvpurchaseDetails.surveyedKiidSrriquantitativeFairValues.asOfClosePriceDatequantitativeFairValues.closePricequantitativeFairValues.quantitativeFairValuequantitativeFairValues.quantitativeFairValueDatequantitativeFairValues.quantitativeFairValueUncertaintyquantitativeFairValues.quantitativeFairValueUncertaintyLabelquantitativeFairValues.quantitativeFinancialHealthquantitativeFairValues.quantitativeFiveStarPricequantitativeFairValues.quantitativeMoatquantitativeFairValues.quantitativeOneStarPricequantitativeRatings.quantitativePriceToFairValuequantitativeRatings.quantitativeStarRatingquantitativeRatings.quantitativeValuationLabelreference.countryNamereference.marketSectorCodereference.marketSegmentCodereference.morningstarVenueIdreturnsPerformanceCurrent.returnDateMoEndriskStatistics.alpha3YrMoEndriskStatistics.beta3YrMoEndriskStatistics.downsideCaptureRatio3YrMoEndriskStatistics.informationRatio3YrMoEndriskStatistics.rSquared3YrMoEndriskStatistics.sortinoRatio3YrMoEndriskStatistics.trackingError3YrMoEndriskStatistics.upsideCaptureRatio3YrMoEndshareClassInformation.cusipshareClassInformation.exchangeCodeshareClassInformation.exchangeSubMarketGlobalIdshareClassInformation.investmentIdshareClassInformation.investmentStatusshareClassInformation.investmentTypeshareClassInformation.ipoDateshareClassInformation.ipoOfferPriceshareClassInformation.isDrshareClassInformation.isMainShareshareClassInformation.isPrimaryPerformanceIdshareClassInformation.marketSymbolshareClassInformation.performanceStatusshareClassInformation.securityTypeshareClassInformation.sedolshareClassInformation.segmentMicCodeshareClassInformation.symbolshareClassInformation.tradingCurrencyshareClassInformation.tradingStatusshortInterest.daysToCovershortInterest.percentageOfFloatshortInterest.percentageOfSharesOutstandingshortInterest.shortInterestValuetrailingReturn.dailyMarketReturnIndextrailingReturn.trailing10YearReturntrailingReturn.trailing15YearReturntrailingReturn.trailing1DayReturntrailingReturn.trailing1MonthReturntrailingReturn.trailing1WeekReturntrailingReturn.trailing1YearReturntrailingReturn.trailing20YearReturntrailingReturn.trailing2MonthReturntrailingReturn.trailing2YearReturntrailingReturn.trailing3MonthReturntrailingReturn.trailing3YearReturntrailingReturn.trailing4YearReturntrailingReturn.trailing5YearReturntrailingReturn.trailing6MonthReturntrailingReturn.trailing6YearReturntrailingReturn.trailing7YearReturntrailingReturn.trailing8YearReturntrailingReturn.trailing9MonthReturntrailingReturn.trailing9YearReturntrailingReturn.trailingGrossedUp10YearReturntrailingReturn.trailingGrossedUp15YearReturntrailingReturn.trailingGrossedUp1DayReturntrailingReturn.trailingGrossedUp1MonthReturntrailingReturn.trailingGrossedUp1WeekReturntrailingReturn.trailingGrossedUp1YearReturntrailingReturn.trailingGrossedUp20YearReturntrailingReturn.trailingGrossedUp2MonthReturntrailingReturn.trailingGrossedUp2YearReturntrailingReturn.trailingGrossedUp3MonthReturntrailingReturn.trailingGrossedUp3YearReturntrailingReturn.trailingGrossedUp4YearReturntrailingReturn.trailingGrossedUp5YearReturntrailingReturn.trailingGrossedUp6MonthReturntrailingReturn.trailingGrossedUp6YearReturntrailingReturn.trailingGrossedUp7YearReturntrailingReturn.trailingGrossedUp8YearReturntrailingReturn.trailingGrossedUp9MonthReturntrailingReturn.trailingGrossedUp9YearReturntrailingReturn.trailingReturnAsOfDateyieldsMostRecent.secYield
aliasstring
An alternative identifier for this data point where one exists. When present, the alias may be used in place of name in requests.
Example:name, performanceId
typestringrequired
The primitive type of the value returned for this data point.
Allowed values:stringdecimalintbool
get/direct-web-services/v1/investment-list/data-points
Authentication
application/json