Skip to content

Estimate Workbench Scraper Credits

GET
/workbench/scraper/credit-estimate

Price a built-in scraper run. CHARGES NOTHING.

A worst-case quote: what max_results rows would cost, plus the post-scrape enrichment when auto_enrich is set, against the live balance. Nothing is scraped and no credit moves.

The estimate and the run share one costing function on purpose, so the number quoted here is the number the run’s own credit gate enforces.

Authorizations

Parameters

Query Parameters

table_id
required

The table the results would land in.

string

The table the results would land in.

max_results
required

Ceiling on results the run would return.

integer

Ceiling on results the run would return.

auto_enrich

Price the post-scrape enrichment too. Leave false and the quote covers the scrape ALONE - which is the number people misread.

boolean

Price the post-scrape enrichment too. Leave false and the quote covers the scrape ALONE - which is the number people misread.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string