Getting Started with the publiFund API

What is it?

The publiFund API is a part of the FE fundinfo suite of APIs. It is a Rest API designed to allow you to build an application that interacts with, displays or otherwise uses the data in publiFund..

Getting a subscription

Before you do anything, the first step is to get a subscription. Everyone has the ability to sign up for a free individual subscription to the FE fundinfo APIs.

A note on data access:
publiFund data is managed on a per-customer basis, and you will need to request access on your account for your Promoter ID, please contact us in order to request access. In the meantime, everyone with an FE Fundinfo API Subscription has access to some test data, by querying against Promoter 0 so you can get started developing right away.

Example call

Use a Request URL that uses Promoter 0 as follows:

https://fefundinfo-api.com/publifundpromoter/0/shareclass

Header should include your Ocp-Apim-Subscription-Key

The Promoter value is used to select and control which Promoter we are querying. Everything after this point specifies what we are accessing in the Promoter, which in this example is all the Promoter's shareclasses. We can read this call as for Promoter 0, give me all the shareclasses they own.

Integrating this call with your application

If your technology can make an outbound HTTP call, then you can use our API. Here's some boilerplate Javascript code to make the call above.

var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function() {
console.log(xhr.responseText)
};
xhr.open('GET', 'https://fefundinfo-api.com/publifund/promoter/0/shareclass');
xhr.setRequestHeader('Ocp-Apim-Subscription-Key', '{subscription key}')
xhr.send();

What's next?

You're now ready to start building your application. You can use Promoter 0 to get started, but you should integrate with your organisation's data when you are able. You might also want to explore the ODATA documentation, which you can use to filter and query your API calls! There are several other endpoints you might also find helpful, for finding subfunds, lists of promoters, and so forth.

The main documentation for the API is located on these pages.

If you are having trouble, or don't know where to go from here, then please get in touch.