Skip to main content
POST
Preview companies matching a signal

Authorizations

X-API-Key
string
header
required

Body

application/json

Preview a signal search.

signal_type
enum<string>
required

Which buying signal a search is looking for.

Each member names one discovery question the provider can answer, and each maps to exactly one upstream endpoint. The last two are firmographic rather than event-shaped — they find companies by what they ARE rather than by what they DID — and are kept in the same enum because they land the same company rows through the same machinery.

Available options:
hiring,
news,
technology,
portfolio_companies,
financing,
products,
firmographics,
extended_firmographics
query
SignalQuerySchema · object

Every filter any signal type can take.

ONE schema for all eight types, mirroring the domain's single query dataclass. Which of these a given signal type actually accepts is decided by the domain's per-type allow-list, and a filter the type cannot use is REJECTED with a 422 naming it — never quietly dropped.

An empty query is valid here. Discovery is bounded by the row cap rather than by the filters, so "the companies that most recently raised" is a legitimate search.

Response

Successful Response

The first page of a signal search.

records
Records · object[]
required

Sample company rows, in the shape they would land in a table.

signal_type
enum<string>
required

Which buying signal a search is looking for.

Each member names one discovery question the provider can answer, and each maps to exactly one upstream endpoint. The last two are firmographic rather than event-shaped — they find companies by what they ARE rather than by what they DID — and are kept in the same enum because they land the same company rows through the same machinery.

Available options:
hiring,
news,
technology,
portfolio_companies,
financing,
products,
firmographics,
extended_firmographics
technology
ResolvedTechnologySchema · object | null
required

The provider's own entry for the technology that was searched.

total
integer | null
required

How many companies match in total, when the provider reports it. Null for every event-shaped signal: there is no count endpoint, so null means UNKNOWN rather than zero.