Keys
API keys, test and live, and what each may do.
Send your key as a bearer token on every call:
Authorization: Bearer hyd_live_...Make, rotate and revoke keys in the dashboard's API keys page. A key is shown once, when it's made; we keep only its hash.
Test and live keys
Test key (hyd_test_) | Live key (hyd_live_) | |
|---|---|---|
| Reads | The sandbox's eleven companies | Every company we have |
| Enrichments | End at once, from the sandbox | Research the company now |
| Cost | Nothing | Credits |
| Limits | 1,000 calls a day, and 100 requests with a webhook_url, per workspace | Your plan's |
Scopes
A key has one or both scopes:
read:GET /v1/companies/{domain},/v1/companies/by-nameand/v1/companies.enrich: everything under/v1/enrichments, andGET /v1/companies/enrich.
A call the key's scopes don't cover is a 403 with the code scope_missing.
When a key is refused
| Status | Code | Why |
|---|---|---|
| 401 | missing_api_key | No Authorization: Bearer header |
| 401 | invalid_api_key | Not a key we know |
| 401 | key_revoked | Revoked in the dashboard |
| 401 | key_expired | Past its expiry, after a rotation |
| 403 | scope_missing | The key lacks the scope the endpoint needs |
| 429 | too_many_unknown_keys | Too many unknown keys from your address in a minute |