API Dictionaries

To see all available on asset classes, return values, and filters provided by the API the user can call the dictionary API functions. These examples are not exhaustive, and more dictionary functions can be found in the EPFR API documentation

To see a database’s asset classes and categories call the dictionary function passing the database’s ID in for a parameter. Below are examples for the fund flows and country allocations databases.

acs_ff <- epfr.get.dictionary.assetclasses("FF")$data 
cs_ff <- epfr.get.dictionary.categories("FF")$data

acs_ca <- epfr.get.dictionary.assetclasses("CA")$data 
cs_ca <- epfr.get.dictionary.categories("CA")$data

Sample rows of the fund flows asset classes dictionary table (all USA asset classes).

id name
FF113002 USA-North America-FF-Equity
FF213002 USA-North America-FF-Bond
FF313002 USA-North America-FF-Balanced
FF413002 USA-North America-FF-Money Market
FF513002 USA-North America-FF-Alternative

For fund filters call the dictionary function associated with the category of filters you are interested in.

ufs <- epfr.get.dictionary.universalfilters()$data

efs <- epfr.get.dictionary.equityfilters()$data  
bfs <- epfr.get.dictionary.bondfilters()$data
afs <- epfr.get.dictionary.alternativefilters()  

For other API variables which are indexed to IDs there will be a get dictionary function associated with them. This function returns all the countries available for the country allocations database.

ctry <- epfr.get.dictionary.countries()$data