sFOX supports the use of API keys to optimize the user experience. API keys can be used to manage your account, create or cancel orders, and to gather real-time information from the sFOX platform, such as market data and accounting data. The API types offered by sFOX are REST, WebSocket and FIX. More information on the different types of API can be found in our API documentation.
Obtaining API keys
API keys for your account can be obtained by following the following steps:
Log in to your sFOX account
Click on the menu-button (3 white lines) in the top right-hand corner
In the drop-down menu, select ‘API keys’
Click on the ‘Add API key’ button
API key permissions
API key permissions are set on the user level. This means that the generated API key will have the same permissions that are granted to the user generating the key (i.e. a user with read-only access is only able to generate a read-only API). It is encouraged that each user generate a unique API key, since this will tie all account actions to unique users within an account.
Third-party account API key
Continuing, it could be the case that you would want to give a third-party (e.g. a fund administrator or an accounting firm) access to your account. This third party is able to create their own API key, based on the permissions you grant to them. To do this, follow the steps below:
Invite the third-party to your team
Log in to your sFOX account
Click on the menu-button (3 white lines) in the top right-hand corner
In the drop-down menu, select ‘Manage users’
Add the third-party to your account by entering their email address and granting them certain permissions
Generating an API key as a team member
As a member of a team you will have a personal sFOX account and be a team member of any accounts you have been invited to. Be sure to have selected the correct account for which you would like an API key by clicking your name at the top right of your screen.
Click on the menu-button (3 white lines) in the top right-hand corner
In the drop-down menu, select ‘API keys’
Click on the ‘Add API key’ button
API testing
Working with and generating API keys can be tested in one of our demo accounts. If you would like to test, please contact sFOX support in the live chat or at support@sfox.com for assistance.