Accessing Your Key
You can locate your API key in the API Console, where you can copy it directly to your clipboard. If you don’t see a key within your API Console:Hit Request API Access and we’ll review and approve your request the same day, so you can start using your key right away.
There is one API Key for the whole team.
Most investment teams work collaboratively from one source of truth. A shared key keeps data permissioning straightforward while still enforcing rate and credit limits at the workspace level.
Keep your key secure
Do not share your key publiclyIt should be treated with the same level of confidentiality as a password, as possession of the key grants access to your firm’s data within the platform.
Make an authenticated query
Once the API key is obtained it can be used in a query by passing it as a header to the query:Data visibility
Sharing to API
- Within the platform, go to My Specter → Searches / Lists.
- Navigate to the saved search you wish to use via the API.
- Click the options menu […] and toggle Share with API.
- The saved search can now be queried and managed by the API. Toggle off at any time to remove API access.
- Lists created via the API are automatically shared with the API and are immediately queryable.
- Saved searches must have a unique name per user (you cannot create two with the same name).
- Saved searches cannot be created via the API at this time.