Welcome to the Silverfin API Reference Documentation, your gateway to exploring the vast capabilities of the Silverfin API. This comprehensive guide empowers you to seamlessly integrate Silverfin's powerful features into your own applications. In this reference, you'll discover a wealth of endpoints, each accompanied by code examples in multiple programming languages. We even offer you the opportunity to test these endpoints directly in the documentation!
To ensure smooth and secure interactions with our API, you'll need an essential component known as an access_token to authorize your requests. The process of obtaining this access_token varies depending on whether you already have a Silverfin account.
Already have an account?
If you already have a Silverfin account, we can can help provide your access token within the documentation without any hassle! Just follow these straightforward steps:
Step 1
Log in to your Silverfin environment at https://live.getsilverfin.com.
Step 2
Go to the Integrations Hub. If you're accessing this page for the first time, you may be prompted to authorize the Silverfin API. Once authorized, you will arrive at the home of the Integrations Hub, which looks like the image below.
Step 3
For the third and final step, you simply need to sign up and/or log into the API documentation with a user account that has the same email address as your Silverfin user.``
If done correctly, you should arrive in the API documentation with a few defaults in place for you. Here are the things you will find:
- Your name in the top of the page matches the name of your user in Silverfin
- Your
access_tokenhas been set correctly in the request section of all the endpoints in the documentation - The
idof the last firm you had access to in Silverfin has been set as the defaultfirm_idin the request section of all the endpoints in the documentation
It should look like the image below
Don't have an account?
There are two things you can do in that case:
- Reach out to Silverfin to request an account
- Reach out to Silverfin to request API credentials for an integration you want to build
If you go with the second option, you will need to perform the authorization flow yourself to retrieve a valid access token. Don't worry, we have you covered with detailed information in our Authentication Guide
Get ready to explore the Silverfin API with confidence, and unlock a world of possibilities for your applications.