Getting started
What is it?
Fundipedia has a comprehensive set of APIs using the Open API standard. The API can be used to extract data on a per object basis, execute a configured report, or retrieve items awaiting approval. It is possible to update the data schema via the API, e.g. creating/updating the data model fields. You can also post data into Fundipedia; this includes creating and updating records.
For all enabled objects:
- GET – retrieve all records
- GET – retrieve a record by ID
- GET – retrieve history by record ID
- POST – create a new record
- POST – action approval
- PUT – update a record
Reports:
- Download a report by ID
- Execute a report by ID
- GET – retrieve list of reports
Retrieve and action pending approvals
Webhooks:
- GET – retrieve all webhooks
- GET – retrieve a webhook by ID
- GET – a message from a webhook by ID
- DELETE – a webhook by ID
- POST – create a new webhook
- PUT – update a webhook
The following functionality is available via webhooks. This can be configured to receive a message when:
- A new record is created
- A record is updated
- A change has been published
- A change has been rejected
How do I get access?
Fundipedia provides the ability for you to communicate with the API via JWT bearer tokens. A bearer token allows developers to have a secure point of entry for using the Fundipedia API, and are one of the core features of OAuth 2.0. See the authentication article to get started.
Each client has their own API and developer portal. The API portal will offer documentation about using the API as well as allowing you to add an API key and test API calls and examine responses.
Before you can request a token you first need to generate an API key and secret from the API developer portal. Here you can create new keys or edit/delete existing keys. When creating a key, you will be shown a secret that pairs with that key, however be sure to take note of this secret as it will only be shown to you once.
To access the development portal you will need a valid Fundipedia user account. User permissions are controlled by system administrators and set via user groups rather than individual users using a user > group > access point permissions model. With the flexibility offered, this means a user can be provided the ability to read only view a subset of fields on say a fund, and only for a subset of fund records.
Below is a screenshot of the development portal describing the actions available on the Fund object:
Requesting the data you need
Pagination
The Fundipedia API provides a way to paginate your calls to limit the amount of data you are fetching. Read more about this in our API pagination article.