Skip to main content
POST
companies.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
query
string

Describe the companies you want, in plain words.

name
string

Company name.

Required string length: 1 - 256
industry
string

Industry or sector, e.g. design software.

Required string length: 1 - 256
technology
string

A technology the company uses.

Required string length: 1 - 256
domain
string

Company website domain, e.g. figma.com.

country
string

Two-letter country code like US, applied where the data source supports it.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
limit
number

How many companies to return, 1 to 50. Default 10.

Required range: x >= 1

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.