Skip to main content
POST
companies.search-suggest

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
field
enum<string>
required

Which filter field to suggest values for: industry, name, market, companyType, employeeRange, specialty, category, country, fundingRound, investor, acquisitionStatus, ticker, technology, technologyCategory.

Available options:
industry,
name,
market,
companyType,
employeeRange,
specialty,
category,
country,
fundingRound,
investor,
acquisitionStatus,
ticker,
technology,
technologyCategory
query
string
default:""

Partial text to match; the exact indexed values that contain it come back. Default "" returns the most common values.

Maximum string length: 512
limit
number

How many values to return, 1 to 100. Default 20.

Required range: x >= 1

Response

The result

values
string[]
required

The source's exact indexed values, best first. Send one back verbatim as the filter value; an empty list means nothing matched.