Skip to main content
GET
Get a search type's row price

Authorizations

X-API-Key
string
header
required

Path Parameters

record_type
enum<string>
required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
hiring_companies,
backlinks,
search_results,
post_authors

Query Parameters

row_count
integer | null

Rows a run would add, to quote their total as credits_for_rows; omit for the per-row price alone.

Required range: x >= 0

Response

Successful Response

One kind of lead search: what its rows cost, and whether it can be sampled first.

The two facts a builder needs before anything is spent, read for free and without fetching a row: asking the price must never itself cost a row.

credits_per_request
number
required

What each request to the data source costs on top of its rows, in credits, charged once for every rows_per_request rows a run adds (a Google search: 0.1 credit for every ten results). Zero for the search types billed by the row alone.

credits_per_row
number
required

What one row of this search type costs, in credits, before any enrichment is chosen. Zero for the search types whose rows are free. Charged on the rows a run adds, so a run that adds nothing costs nothing. Never included in an enrichment's credits_per_row, so a true total is this plus the ticked enrichments rather than either alone.

preview_supported
boolean
required

Whether this search type can be sampled before it is added. The backend lists which datasets offer an explicit sample. This is independent of row pricing; automatic counts are only available when the data source counts for free.

record_type
enum<string>
required

Which dataset the search runs against.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
hiring_companies,
backlinks,
search_results,
post_authors
rows_per_request
integer
required

How many rows one request to the data source returns, and so how many each request charge covers.

credits_for_rows
number | null

What row_count rows cost before any enrichment, request charges included and rounded once on the total; null if no row_count was given. The rows a run adds are what gets charged, so a run that matches fewer rows than asked for costs less than this.