Skip to main content

Equidam API: getting an API key and what you can do with it

Equidam turns on API access per organisation. You get an API key by signing in through the API, then send it as a Bearer token on every request.

Written by Daniel

The Equidam API (application programming interface) lets your software or AI assistant create companies, send valuation inputs and read results without opening the app. Equidam turns API access on per organisation, and each person signs in through the API to get their own API key, also called a token.

Who can use the Equidam API?

API access is a setting on your organisation that only Equidam staff can switch on or off, so contact Equidam to ask for it. Then any member can get a key.

A key acts as the person who created it and reaches the same companies they reach in the app. Plan rules still apply: on the free plan you cannot generate a valuation report, and Benchmarks data needs Benchmarks access on your plan.

How do I get an API key?

  1. Ask Equidam to turn on API access for your organisation.

  2. Send a POST request to /api/login with a JSON body containing your email and password.

  3. The response body is your key, as plain text. Store it straight away; nothing shows it again.

  4. Send the key on every request in the header Authorization: Bearer <your key>. API paths start with /api/v3.

A key is valid for 6 months, then you sign in again for a new one. Each sign-in creates a new key; earlier keys keep working until they expire or are revoked.

How do I revoke an API key?

Send a POST request to /api/logout with the key in the header. This revokes every key your user account holds, including keys used by other integrations that share your login. No endpoint revokes a single key.

If Equidam turns API access off for your organisation, the company, report and settings endpoints return a 401 error for its keys.

What can I do with the API?

It covers app data, one company at a time:

  • list, create and delete companies

  • submit the 10-question estimate, which most other endpoints require first

  • read and save the questionnaire and financial projections, including the balance sheet

  • read and save the cap table, SAFEs (Simple Agreements for Future Equity) and convertible notes, which are loans that convert into shares

  • read and override method weights and the other advanced settings

  • read the valuation results shown on the dashboard

  • list and generate valuation reports, and download the company data export

Some saves replace rather than merge: a cap table sent without a shareholder deletes that shareholder. Read the current data, change it, then send all of it back.

Using Equidam from an AI assistant (MCP tools)

Three tool endpoints serve AI assistants that use MCP (Model Context Protocol), an open standard for connecting assistants to outside tools. They live under /api/v3/mcp/tools/ and are called with a Bearer key.

  • classify_company_industry takes a description of the business, 10 to 2,000 characters. It returns a suggested industry with up to 3 alternatives, or asks for more detail when its confidence is below 0.5.

  • select_industry_classification confirms the industry code the user picked.

  • get_company_valuation takes the industry code, last year's revenue, revenue projected 3 years ahead and a 2-letter country code. Currency, headcount and founding year are optional. It returns a low, high and average valuation.

classify_company_industry sends the business description to an AI model, which suggests an industry for the user to confirm. The AI does not set the valuation. See AI features and your data.

The valuation tool runs the 10-question estimate logic. Equidam stores the inputs and result under a separate service account linked to your key, outside your company list and not visible in the app.

Where is the API reference?

An interactive OpenAPI (Swagger) reference is at /api/documentation on the Equidam app, with the raw specification at /api/default/docs. Benchmarks endpoints have their own reference at /api/vda/documentation.

Common questions

Can I create an API key in my Equidam settings?

No. The app has no screen for keys. Send your email and password to /api/login.

I lost my API key. Can I see it again?

No. Sign in through /api/login again to get a new key.

Does a valuation from the MCP tool appear in my company list?

No. Its inputs are stored under a separate service account, not in your company list. To keep a valuation, create the company in Equidam.

Related articles

Did this answer your question?