Federated Hermes Product API

The Federated Hermes Product API is a RESTful API that can be used to retrieve information about Federated Hermes' products including key attributes and performance data.

The API has typical RESTful characteristics and uses JSON or XML for the output.

For more information on usage and how to get started Contact Us.


Special Case Data Type Syntax
data type context for syntax
Integer / Long
  • "?parameter=123": parameter equals "123"
  • "?parameter=-123": parameter not equals "123"
String (number)
  • "?parameter={"eq": 123}": parameter equals "123"
  • "?parameter={"ne": 123}": parameter not equals "123"
  • "?parameter={"gt": 100, "lt": 200}": parameter is greater than "100" and less than "200"
  • "?parameter={"gte": 100, "lte": 200}": parameter is greater than or equal to "100" and less than or equal to "200"
  • "?parameter={"gte": 100, "lte": 200, "ne": 150}": parameter is greater than or equal to "100" and less than or equal to "200" and not equal to "150"
  • Integer / Long syntax will also work with these fields.
String (text)
  • "?parameter=abc": parameter case sensitive equals "abc"
  • "?parameter=-abc": parameter case sensitive not equals "abc"
  • "?parameter=:abc": parameter case insensitive equals "abc"
  • "?parameter=!abc": parameter case insensitive not equals "abc"
  • "?parameter=*abc": parameter case sensitive like "*abc", where * is a wildcard
  • "?parameter=abc*": parameter case sensitive like "abc*", where * is a wildcard
  • "?parameter=*abc*": parameter case sensitive like "*abc*", where * is a wildcard
  • "?parameter=`abc": parameter case sensitive not like "*abc", where * is a wildcard
  • "?parameter=abc`": parameter case sensitive not like "abc*", where * is a wildcard
  • "?parameter=`abc`": parameter case sensitive not like "*abc*", where * is a wildcard
  • "?parameter=~abc": parameter case insensitive like "*abc", where * is a wildcard
  • "?parameter=abc~": parameter case insensitive like "abc*", where * is a wildcard
  • "?parameter=~abc~": parameter case insensitive like "*abc*", where * is a wildcard
  • "?parameter=|abc": parameter case insensitive not like "*abc", where * is a wildcard
  • "?parameter=abc|": parameter case insensitive not like "abc*", where * is a wildcard
  • "?parameter=|abc|": parameter case insensitive not like "*abc*", where * is a wildcard
String (orderBy)
  • "?orderBy=name": order the results by name in ascending order
  • "?orderBy=-name": order the results by name in descending order
  • "?orderBy=name,date": order the results by name in ascending order and then order the results by date in ascending order
  • "?orderBy=name,-date": order the results by name in ascending order and then order the results by date in descending order
String (date / date range)
  • "?parameter=2018-01-01": parameter=2018-01-01
  • "?parameter={2018-01-01,2018-04-08}": (parameter >= 2018-01-01 and parameter <= 2018-04-08)
  • "?parameter={2018-01-01,}": (parameter >= 2018-01-01)
  • "?parameter={,2018-04-08}": (parameter <= 2018-04-08)
  • "?parameter={2018-01-01;2018-04-08}": (parameter > 2018-01-01 and parameter < 2018-04-08)
  • "?parameter={2018-01-01;}": (parameter > 2018-01-01)
  • "?parameter={;2018-04-08}": (parameter < 2018-04-08)
  • "?parameter={2018-01-01>2018-04-08}": (parameter >= 2018-01-01 and parameter < 2018-04-08)
  • "?parameter={2018-01-01>}": (parameter >= 2018-01-01)
  • "?parameter={>2018-04-08}": (parameter < 2018-04-08)
  • "?parameter={2018-01-01<2018-04-08}": (parameter > 2018-01-01 and parameter <= 2018-04-08)
  • "?parameter={2018-01-01<}": (parameter > 2018-01-01)
  • "?parameter={<2018-04-08}": (parameter <= 2018-04-08)

Resources

name path methods description
AnnualizedReturns
  • /fund-service/v2/annualizedReturns
  • /fund-service/v2/annualizedReturns/returnDate
  • /fund-service/v2/annualizedReturns/{id}
  • GET
  • GET
  • GET
Provides annualized returns and dates.
AssetClasses
  • /fund-service/v2/assetClasses
  • /fund-service/v2/assetClasses/{id}
  • GET
  • GET
Provides asset classes.
Authenticate
  • /fund-service/v2/authenticate
  • POST
Authenticates a specified user to allow access to non-public_anonymous API calls. API calls within this web service have 3 different levels of authorization which are described below.
  1. "PUBLIC_ANONYMOUS": These API's do not require any authentication to use.
  2. "PUBLIC_AUTHENTICATED": These API's require authentication with a public role to use. Users with this role may also access PUBLIC_ANONYMOUS API's.
  3. "PRIVATE_AUTHENTICATED": These API's require authentication with a private role to use. Users with this role may also access PUBLIC_ANONYMOUS and PUBLIC_AUTHENTICATED API's.
Attempting to use a non-public_anonymous API call may result in the following HTTP status codes.
  1. 401: The token contains an invalid claim or the token has expired.
  2. 403: The Authorization header is missing, the Authorization header is invalid, or the token in the Authorization header contains insufficient privileges for this API call.
Benchmarks
  • /fund-service/v2/benchmarks
  • /fund-service/v2/benchmarks/calendarYear
  • /fund-service/v2/benchmarks/{id}
  • GET
  • GET
  • GET
Provides benchmark returns and dates.
CalculatorProducts
  • /fund-service/v2/calculatorProducts
  • /fund-service/v2/calculatorProducts/{id}
  • GET
  • GET
Provides product information for those products that are allowed to be used for calculator related data.
CalendarYearReturns
  • /fund-service/v2/calendarYearReturns
  • /fund-service/v2/calendarYearReturns/{id}
  • GET
  • GET
Provides calendar year returns.
CharacteristicsAssetClosedEnds
  • /fund-service/v2/characteristicsAssetClosedEnds
  • /fund-service/v2/characteristicsAssetClosedEnds/dailyAssetsDate
  • /fund-service/v2/characteristicsAssetClosedEnds/monthlyAssetsDate
  • /fund-service/v2/characteristicsAssetClosedEnds/{id}
  • GET
  • GET
  • GET
  • GET
Provides daily and monthly assets and dates for closed end funds.
CharacteristicsAssets
  • /fund-service/v2/characteristicsAssets
  • /fund-service/v2/characteristicsAssets/dailyAssetsDate
  • /fund-service/v2/characteristicsAssets/{id}
  • GET
  • GET
  • GET
Provides daily and monthly assets and dates for non-closed end funds.
CitiProducts
  • /fund-service/v2/citiProducts
  • /fund-service/v2/citiProducts/{id}
  • GET
  • GET
Provides Citi product related data.
CorpDividendReceives
  • /fund-service/v2/corpDividendReceives
  • /fund-service/v2/corpDividendReceives/{id}
  • GET
  • GET
Provides income dividend distribution data.
CumulativeReturns
  • /fund-service/v2/cumulativeReturns
  • /fund-service/v2/cumulativeReturns/returnDate
  • /fund-service/v2/cumulativeReturns/{id}
  • GET
  • GET
  • GET
Provides cumulative returns and dates.
Currencies
  • /fund-service/v2/currencies
  • /fund-service/v2/currencies/{id}
  • GET
  • GET
Provides currencies.
CurrentDailyFundPerformances
  • /fund-service/v2/currentDailyFundPerformances
  • /fund-service/v2/currentDailyFundPerformances/{id}
  • GET
  • GET
Provides current daily fund performance related data.
CurrentInvestProdTotalReturns
  • /fund-service/v2/currentInvestProdTotalReturns
  • /fund-service/v2/currentInvestProdTotalReturns/{id}
  • GET
  • GET
Provides annualized returns.
DailyAssetPerformances
  • /fund-service/v2/dailyAssetPerformances
  • /fund-service/v2/dailyAssetPerformances/performanceDate
  • /fund-service/v2/dailyAssetPerformances/{id}
  • GET
  • GET
  • GET
Provides daily asset performance data.
DailyPerformanceMetrics
  • /fund-service/v2/dailyPerformanceMetrics
  • /fund-service/v2/dailyPerformanceMetrics/performanceDate
  • /fund-service/v2/dailyPerformanceMetrics/{id}
  • GET
  • GET
  • GET
Provides daily performance data and dates.
DailyRates
  • /fund-service/v2/dailyRates
  • /fund-service/v2/dailyRates/{id}
  • GET
  • GET
Provides performance data for liquidity funds.
DiscontinuedProductViews
  • /fund-service/v2/discontinuedProductViews
  • /fund-service/v2/discontinuedProductViews/{id}
  • GET
  • GET
Provides discontinued product characteristics information.
DiscontinuedProducts
  • /fund-service/v2/discontinuedProducts
  • /fund-service/v2/discontinuedProducts/{id}
  • GET POST PUT
  • DELETE GET
Provides discontinued product characteristics information.
Distributions
  • /fund-service/v2/distributions
  • /fund-service/v2/distributions/distributionsDate
  • /fund-service/v2/distributions/{id}
  • GET
  • GET
  • GET
Provides income dividend distribution data.
EffectiveMaturitySchedules
  • /fund-service/v2/effectiveMaturitySchedules
  • /fund-service/v2/effectiveMaturitySchedules/{id}
  • /fund-service/v2/effectiveMaturitySchedules/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of a product’s holdings by the effective maturity schedule.
EsgIcons
  • /fund-service/v2/esgIcons
  • /fund-service/v2/esgIcons/{id}
  • GET
  • GET
Provides product Environmental, Social, and Corporate Governance (ESG) icon information.
FedAltMinTaxes
  • /fund-service/v2/fedAltMinTaxes
  • /fund-service/v2/fedAltMinTaxes/{id}
  • GET
  • GET
Provides federal alternative tax data.
FinalCapitalGains
  • /fund-service/v2/finalCapitalGains
  • /fund-service/v2/finalCapitalGains/{id}
  • GET
  • GET
Provides capital gains data.
ForeignTaxes
  • /fund-service/v2/foreignTaxes
  • /fund-service/v2/foreignTaxes/{id}
  • GET
  • GET
Provides foreign tax data.
FundDocuments
  • /fund-service/v2/fundDocuments
  • /fund-service/v2/fundDocuments/{id}
  • GET
  • GET
Provides information on a product’s reports.
FundNumbers
  • /fund-service/v2/fundNumbers
  • /fund-service/v2/fundNumbers/{id}
  • GET
  • GET
Provides transfer agent fund numbers data.
HypotheticalTools
  • /fund-service/v2/hypotheticalTools
  • /fund-service/v2/hypotheticalTools/{id}
  • GET
  • GET
Provides Hypothetical Tools related data.
Industries
  • /fund-service/v2/industries
  • /fund-service/v2/industries/{id}
  • /fund-service/v2/industries/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of a product’s holdings by industry sector.
IntDividendPercents
  • /fund-service/v2/intDividendPercents
  • /fund-service/v2/intDividendPercents/{id}
  • GET
  • GET
InterestRates
  • /fund-service/v2/interestRates
  • /fund-service/v2/interestRates/{id}
  • /fund-service/v2/interestRates/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of a product’s holdings by fixed rate versus floating rate.
IntradayFundPerformances
  • /fund-service/v2/intradayFundPerformances
  • /fund-service/v2/intradayFundPerformances/{id}
  • GET
  • GET
Provides intraday performance data.
IntradayStrikeTimes
  • /fund-service/v2/intradayStrikeTimes
  • /fund-service/v2/intradayStrikeTimes/{id}
  • GET
  • GET
Provides intraday strike times.
KeyFacts
  • /fund-service/v2/keyFacts
  • /fund-service/v2/keyFacts/{id}
  • GET
  • GET
Provides KeyFacts related data.
MapProducts
  • /fund-service/v2/mapProducts
  • /fund-service/v2/mapProducts/{id}
  • GET
  • GET
Provides product data for Manage Account Pools.
MaturityRanges
  • /fund-service/v2/maturityRanges
  • /fund-service/v2/maturityRanges/{id}
  • /fund-service/v2/maturityRanges/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of holdings by maturity range.
MedianSpreads
  • /fund-service/v2/medianSpreads
  • /fund-service/v2/medianSpreads/performanceDate
  • /fund-service/v2/medianSpreads/{id}
  • GET
  • GET
  • GET
Provides median spread data and dates.
MicrositeProducts
  • /fund-service/v2/micrositeProducts
  • /fund-service/v2/micrositeProducts/{id}
  • GET
  • GET
Provides product data for products on Federated’s microsites.
MonthlyAssetPerformances
  • /fund-service/v2/monthlyAssetPerformances
  • /fund-service/v2/monthlyAssetPerformances/performanceDate
  • /fund-service/v2/monthlyAssetPerformances/{id}
  • GET
  • GET
  • GET
Provides monthly asset performance data.
MorningstarCategoryStyles
  • /fund-service/v2/morningstarCategoryStyles
  • /fund-service/v2/morningstarCategoryStyles/{id}
  • GET
  • GET
Provides Morningstar® category and style related data.
MorningstarRatings
  • /fund-service/v2/morningstarRatings
  • /fund-service/v2/morningstarRatings/{id}
  • GET
  • GET
Provides Morningstar® ratings related data.
PortCompAssetClasses
  • /fund-service/v2/portCompAssetClasses
  • /fund-service/v2/portCompAssetClasses/{id}
  • /fund-service/v2/portCompAssetClasses/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by asset class.
PortCompCountries
  • /fund-service/v2/portCompCountries
  • /fund-service/v2/portCompCountries/{id}
  • /fund-service/v2/portCompCountries/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by country.
PortCompDiversities
  • /fund-service/v2/portCompDiversities
  • /fund-service/v2/portCompDiversities/{id}
  • /fund-service/v2/portCompDiversities/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by diversity.
PortCompDurations
  • /fund-service/v2/portCompDurations
  • /fund-service/v2/portCompDurations/{id}
  • /fund-service/v2/portCompDurations/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by duration.
PortCompEquities
  • /fund-service/v2/portCompEquities
  • /fund-service/v2/portCompEquities/{id}
  • /fund-service/v2/portCompEquities/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by Equity sector.
PortCompMarketCaps
  • /fund-service/v2/portCompMarketCaps
  • /fund-service/v2/portCompMarketCaps/{id}
  • /fund-service/v2/portCompMarketCaps/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by market cap.
PortCompStates
  • /fund-service/v2/portCompStates
  • /fund-service/v2/portCompStates/{id}
  • /fund-service/v2/portCompStates/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by state.
PortComps
  • /fund-service/v2/portComps
  • /fund-service/v2/portComps/{id}
  • /fund-service/v2/portComps/max/asOfDate
  • GET
  • GET
  • GET
Provides various breakdowns of product holdings.
PortfolioCallables
  • /fund-service/v2/portfolioCallables
  • /fund-service/v2/portfolioCallables/{id}
  • /fund-service/v2/portfolioCallables/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by call schedule.
PortfolioCompositionCurrencies
  • /fund-service/v2/portfolioCompositionCurrencies
  • /fund-service/v2/portfolioCompositionCurrencies/{id}
  • /fund-service/v2/portfolioCompositionCurrencies/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by currency.
PortfolioProfileMoneyMarketMonthlies
  • /fund-service/v2/portfolioProfileMoneyMarketMonthlies
  • /fund-service/v2/portfolioProfileMoneyMarketMonthlies/{id}
  • /fund-service/v2/portfolioProfileMoneyMarketMonthlies/max/asOfDate
  • GET
  • GET
  • GET
Provides monthly WAM and WAL performance data.
PortfolioProfileMoneyMarkets
  • /fund-service/v2/portfolioProfileMoneyMarkets
  • /fund-service/v2/portfolioProfileMoneyMarkets/{id}
  • /fund-service/v2/portfolioProfileMoneyMarkets/max/asOfDate
  • GET
  • GET
  • GET
Provides daily WAM and WAL performance data.
PortfolioProfiles
  • /fund-service/v2/portfolioProfiles
  • /fund-service/v2/portfolioProfiles/{id}
  • /fund-service/v2/portfolioProfiles/max/asOfDate
  • GET
  • GET
  • GET
Provides monthly weighted average performance data.
Positionings
  • /fund-service/v2/positionings
  • /fund-service/v2/positionings/{id}
  • /fund-service/v2/positionings/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by market cap.
PreferredShareRatings
  • /fund-service/v2/preferredShareRatings
  • /fund-service/v2/preferredShareRatings/{id}
  • GET
  • GET
Provides credit ratings for closed end fund preferred shares.
PremiumDiscounts
  • /fund-service/v2/premiumDiscounts
  • /fund-service/v2/premiumDiscounts/performanceDate
  • /fund-service/v2/premiumDiscounts/{id}
  • GET
  • GET
  • GET
Provides premium discount data and dates.
ProductAlertViews
  • /fund-service/v2/productAlertViews
  • /fund-service/v2/productAlertViews/{id}
  • GET
  • GET
Provides product alerts related data.
ProductAlerts
  • /fund-service/v2/productAlerts
  • /fund-service/v2/productAlerts/{id}
  • GET POST PUT
  • GET
Provides product alerts related data.
ProductCategories
  • /fund-service/v2/productCategories
  • /fund-service/v2/productCategories/{id}
  • GET
  • GET
Provides product categories.
ProductDisclosures
  • /fund-service/v2/productDisclosures
  • /fund-service/v2/productDisclosures/{id}
  • GET
  • GET
ProductOverviews
  • /fund-service/v2/productOverviews
  • /fund-service/v2/productOverviews/{id}
  • GET
  • GET
Provides product information.
ProductPermissions
  • /fund-service/v2/productPermissions
  • /fund-service/v2/productPermissions/{id}
  • GET POST PUT
  • DELETE GET
Provides information on which tabs are shown on the product detail pages.
ProductSubscriptionOptions
  • /fund-service/v2/productSubscriptionOptions
  • /fund-service/v2/productSubscriptionOptions/{id}
  • GET
  • GET
Provides an ordering of share classes for the subscription option page.
ProductTypes
  • /fund-service/v2/productTypes
  • /fund-service/v2/productTypes/{id}
  • GET
  • GET
Provides product types.
Products
  • /fund-service/v2/products
  • /fund-service/v2/products/{id}
  • GET
  • GET
Provides product characteristics information.
ProspectusesAndRegulatoryReports
  • /fund-service/v2/prospectusesAndRegulatoryReports
  • /fund-service/v2/prospectusesAndRegulatoryReports/{id}
  • GET
  • GET
Provides information on prospectuses and regulatory reports.
QualifiedDividends
  • /fund-service/v2/qualifiedDividends
  • /fund-service/v2/qualifiedDividends/{id}
  • GET
  • GET
Provides dividend and short term capital gain information.
Qualities
  • /fund-service/v2/qualities
  • /fund-service/v2/qualities/{id}
  • /fund-service/v2/qualities/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by quality ratings.
RegionalBreakdowns
  • /fund-service/v2/regionalBreakdowns
  • /fund-service/v2/regionalBreakdowns/{id}
  • /fund-service/v2/regionalBreakdowns/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown product holdings by region.
ReturnCaps
  • /fund-service/v2/returnCaps
  • /fund-service/v2/returnCaps/{id}
  • GET
  • GET
Provides return on capital information.
SearchAsYouTypeOptions
  • /fund-service/v2/searchAsYouTypeOptions
  • /fund-service/v2/searchAsYouTypeOptions/{id}
  • GET
  • GET
Provides keywords used in the search as you type option.
SecMoneyMarkets
  • /fund-service/v2/secMoneyMarkets
  • /fund-service/v2/secMoneyMarkets/{id}
  • GET
  • GET
Provides Securities and Exchange Commission (SEC) required information for money market products.
ShareClassNames
  • /fund-service/v2/shareClassNames
  • /fund-service/v2/shareClassNames/{id}
  • GET
  • GET
Provides share class names.
ShareClasses
  • /fund-service/v2/shareClasses
  • /fund-service/v2/shareClasses/{id}
  • /fund-service/v2/shareClasses/{id}/intradayStrikeTimes
  • GET
  • GET
  • GET
Provides share class attribute information.
StandardPerformances
  • /fund-service/v2/standardPerformances
  • /fund-service/v2/standardPerformances/{id}
  • GET
  • GET
Provides standard performance data.
StateTaxByIssuers
  • /fund-service/v2/stateTaxByIssuers
  • /fund-service/v2/stateTaxByIssuers/{id}
  • GET
  • GET
Provides year end state tax information.
StateTaxShortTerms
  • /fund-service/v2/stateTaxShortTerms
  • /fund-service/v2/stateTaxShortTerms/{id}
  • GET
  • GET
Provides taxable short term capital gain information.
StateTaxStates
  • /fund-service/v2/stateTaxStates
  • /fund-service/v2/stateTaxStates/{id}
  • GET
  • GET
Provides a breakdown of state tax information.
TopHoldings
  • /fund-service/v2/topHoldings
  • /fund-service/v2/topHoldings/{id}
  • /fund-service/v2/topHoldings/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of the top holdings for products.
TotalReturns
  • /fund-service/v2/totalReturns
  • /fund-service/v2/totalReturns/{id}
  • GET
  • GET
Provides total return data.
Websites
  • /fund-service/v2/websites
  • /fund-service/v2/websites/{id}
  • GET
  • GET
Provides Federated’s websites.
Weightings
  • /fund-service/v2/weightings
  • /fund-service/v2/weightings/{id}
  • /fund-service/v2/weightings/max/asOfDate
  • GET
  • GET
  • GET
Provides a breakdown of product holdings by sector weightings.
YieldReturns
  • /fund-service/v2/yieldReturns
  • /fund-service/v2/yieldReturns/performanceDate
  • /fund-service/v2/yieldReturns/{id}
  • GET
  • GET
  • GET
Provides yield data.

Data Types

XML

Default Namespace
type description
micrositeTypeEnum
annualizedReturn
assetClass
benchmark
calculatorProduct
calendarYearReturn
characteristicsAsset
characteristicsAssetClosedEnd
citiProduct
corpDividendReceived
count
cumulativeReturn
currency
currentDailyFundPerformance
currentInvestProdTotalReturn
dailyAssetPerformance
dailyPerformanceMetric
dailyRate
discontinuedProduct
distribution
effectiveMaturitySchedule
esgIcon
fedAltMinTax
finalCapitalGain
foreignTax
fundDocument
fundNumber
hypotheticalTool
industry
intDividendPercent
interestRate
intradayFundPerformance
intradayStrikeTime
keyFact
mapsProduct
maturityRange
medianSpread
micrositeProduct
monthlyAssetPerformance
morningstarCategoryStyle
morningstarRating
portComp
portCompAssetClass
portCompCountry
portCompDiversity
portCompDuration
portCompEquity
portCompMarketCap
portCompState
portfolioCallable
portfolioCompositionCurrency
portfolioProfile
portfolioProfileMoneyMarket
portfolioProfileMoneyMarketMonthly
positioning
preferredShareRating
premiumDiscount
premiumDiscountSummary
product
productAlert
productAlertView
productCategory
productCompareOverview
productDisclosure
productOverview
productPermission
productSubscriptionOption
productType
prospectusesAndRegulatoryReport
qualifiedDividend
quality
regionalBreakdown
returnCap
searchAsYouTypeOption
secMoneyMarket
shareClass
shareClassName
standardPerformance
stateTaxByIssuer
stateTaxShortTerm
stateTaxState
topHolding
totalReturn
website
weighting
yieldReturn
abstractResource
dateInstance
dateRange
id
link