Skip to main content
ScrapingBuddy
Skip to content
ScrapingBuddyDevelopers
Dashboard
On this page Use your customer key

Scraping API/Guides

Authentication & access

Connect your server with your customer API key and understand public-page access.

Use your customer key

Create a key in Profile > API access and save it when shown. Send Authorization: Bearer YOUR_API_KEY on every scraping request. Your key identifies your account and can only read your own tasks.

Use your ScrapingBuddy customer key, not an upstream provider key. Keep it out of frontend bundles, browser requests, URLs and source control. Revoke a compromised key and create a replacement.

Request headers
GET /api/v1/scraping/tasks?offset=0 HTTP/1.1
Host: www.scrapingbuddy.com
Authorization: Bearer YOUR_API_KEY

Public-page testing access

Manual account and hostname approval is not required during the current testing stage. Use an authenticated dashboard session or a valid customer API key. The target must still resolve only to public internet addresses.

Only public HTTP or HTTPS pages on standard ports are accepted. Private addresses, IP-literal URLs, URL credentials and credential query parameters are rejected. Authentication, task ownership and usage limits still apply.

Send JSON and a saved task key

Task creation additionally requires Content-Type: application/json and a UUID v4 Idempotency-Key. Save the key with the request before you send it.

The base URL is https://www.scrapingbuddy.com/api/v1. Use /scraping/tasks to create or list tasks, and /scraping/tasks/{id} to retrieve one.

Manage API keysAPI referenceContact support
Scraping API v1
Getting startedIntroductionYour first scrapeAuthentication & access
GuidesBulk classificationAI analysis & company contextFormats & page readinessTask lifecycle & retentionSafe retriesErrors, limits & billing
API keys Contact support

Explore the documentation

Scraping APIIntroduction

Public pages, HTML, Markdown, deep research, bulk classification, wallet billing and first integration.

GuidesBulk classification

One question, your own answer labels, and a separate machine-readable result for each website.

GuidesYour first scrape

Go from a public URL to saved page content in four steps.

GuidesAuthentication & access

Connect your server with your customer API key and understand public-page access.

GuidesAI analysis & company context

Extract information, summarize a page or assess relevance with optional OpenAI analysis.

GuidesFormats & page readiness

Choose the content format and when the page is ready to collect.

GuidesTask lifecycle & retention

Know when to poll, when to save content and when to stop.

GuidesSafe retries

Recover a lost response without accidentally creating another task.

GuidesErrors, limits & billing

Understand request failures, task failures and usage-based billing.

POST /scraping/tasksCreate a task

Collect a public page, with optional single-page or deep analysis. During the current testing stage, a valid customer API key is enough to create a public-page task; separate accou

GET /scraping/tasks/{id}Get a task & result

Read task progress and retrieve content when it is ready. Fetch the saved task ID with the same account that created it. Wait at least 6 seconds between progress checks. This reque

GET /scraping/tasksList task history

Find your recent tasks, newest first, without downloading page content. Returns up to 10 tasks per page, ordered by creation time and ID, plus hasMore. Request offset=0, then 10, t

POST /scraping/classificationsCreate a classification batch

Ask one question across up to 100 URLs and constrain answers to your own labels. Send a saved UUID v4 Idempotency-Key and JSON body of at most 256 KiB. The key becomes batch.id. An

GET /scraping/classifications/{id}Get classification results

Retrieve batch progress and all per-URL decisions. Use the batch ID and a key belonging to the same account. Poll at least 10 seconds apart. Returns 202 while queued or running, an

GET /scraping/classificationsList classification batches

Read paginated batch summaries and current classification availability. Returns up to 10 batches, newest first, without items. Use offset=0, then 10, then 20 while hasMore is true.

POST /scraping/classifications/{id}/cancelStop queued classification URLs

Stop batch items that have not started; let in-flight work finish. Send Authorization only; no request body or new Idempotency-Key is required. Repeating cancellation is safe. Only