---
title: "Estimate Workbench Scraper Credits"
method: GET
path: "/workbench/scraper/credit-estimate"
tags: ["Workbench"]
---

# Estimate Workbench Scraper Credits

`GET /workbench/scraper/credit-estimate`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/workbench/scraper/credit-estimate`
- Auth: HTTP bearer

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.

## Query parameters

- `table_id` string, required: The table the results would land in.
- `max_results` integer, required: Ceiling on results the run would return.
- `auto_enrich` boolean: Price the post-scrape enrichment too. Leave false and the quote covers the scrape ALONE - which is the number people misread.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseEnrichmentPayload
  - `data` EnrichmentPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)