Skip to main content
POST
companies.profile.lookup

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
domain
string

Company domain.

name
string

Company name.

Required string length: 1 - 256
profileUrl
string

Company public profile URL.

ticker
string

Exchange ticker.

Required string length: 1 - 32
location
string

Headquarters location hint.

Required string length: 1 - 256
streetAddress
string

Headquarters street address.

Required string length: 1 - 256
city
string

Headquarters city.

Required string length: 1 - 128
region
string

Headquarters region.

Required string length: 1 - 128
country
string

Headquarters country name.

Required string length: 1 - 128
postalCode
string

Headquarters postal code; send country too.

Required string length: 1 - 32
groups
enum<string>[]

Explicit groups; default profile. Premium groups cost extra. Arrays capped at 50 entries.

Required array length: 1 - 6 elements

Company field group.

Available options:
profile,
funding,
workforce,
growth,
technology,
hiring

Response

The result

company
object
required

Matched company and requested aggregate groups.