Skip to main content
POST
companies.search-bulk

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}$

Body

application/json
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}$
maxRows
integer
default:100

How many companies the job may deliver, 1 to 10000. The job stops there and is limited to it upstream. Default 100. Each delivered company costs the same as a page-search result; the technology filter adds a full credit per company.

Required range: 1 <= x <= 10000

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.