API Reference

This page will help you get started with the Equidam Valuation API.

Follow these 4 steps to calculate the valuation of your first company

1. ๐Ÿท Login

When given access to the API, you'll be given username and password for your account
You'll be able to use those on the login endpoint to get a token.
Tokens expire in 6 months, so an unauthenticated sequence that attempts login again is advised when 403 errors are thrown

2. ๐Ÿข Creation of companies

Your API account comes with a new empty company, you can ignore it or use it for testing
Otherwise, in the companies endpoint, you can create a new company using a POST and retrieve the list of your companies. After creating a new company you must define the company name ->/companies/CID/

3. ๐Ÿ—ณ Saving data in a company

There are several endpoints to save data for a company.
You NEED to start from tenq. -> /companies/CID/tenq/

This saves the first 10 questions required to kickstart the valuation and is also the smallest subset of data required to give a very broad valuation estimate
The other endpoints that will complete the data are (in order of descending importance):

4. ๐Ÿ“ˆ Retrieve calculated data

The most complete for of output of Equidam's valuation is the report. You can retrieve reports at the report endpoints.Another source of data is the dashboard endpoint. This mimics what we provide to the dashboard on the Equidam platform, it's a summary of the most important data the user looks at.

5. ๐Ÿ“„ Additional Files

We've uploaded some files we think could be useful for the integration. You can find them at this link

๐ŸšฆLimitations


Please do not abuse the API endpoints even for testing. The API throttles with too many calls, and will block additional ones for some time