This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
When to use this: choose similar companies after you already have one good seed account and want adjacent accounts.
Pricing: 1 credit per 10 returned companies. Credits are charged on actual returned results, not requested limit.
Body parameters
queryrequiredstring
Semantic description of desired peer companies. Length: 10–700 characters.
company_name· optionalstring
Optional seed company name, used only to exclude that seed from results.
company_domain· optionalstring
Optional official seed domain, used only to exclude that seed from results.
limit· optionalinteger
Maximum results. Default: 10. Range: 1–100.
| Name | Type | Description |
|---|---|---|
| queryrequired | string | Semantic description of desired peer companies. Length: 10–700 characters. |
| company_name | string | Optional seed company name, used only to exclude that seed from results. |
| company_domain | string | Optional official seed domain, used only to exclude that seed from results. |
| limit | integer | Maximum results. Default: 10. Range: 1–100. |
Errors
| Status | Meaning |
|---|---|
| 400 | The search/provider rejected the request. |
| 422 | query must contain 10–700 characters; typed range or body validation failed. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing search:run scope. |
