Skip to main content

Documentation Index

Fetch the complete documentation index at: https://brezelscraper.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

BrezelScraper exposes a REST API at https://api.brezelscraper.com/api/v1.

​
Base URL

  • Production: https://api.brezelscraper.com/api/v1
  • Local development: http://localhost:8080/api/v1

​
Choose your authentication mode

  • Browser flows in the dashboard use your signed-in session automatically.
  • Server-to-server automations should use a bscraper_ API key.

​
Typical automation flow

  1. Create an API key in the dashboard.
  2. Estimate a job with POST /jobs/estimates.
  3. Create a job with POST /jobs.
  4. Check status with GET /jobs/{id} or list all with GET /jobs.
  5. Fetch results with GET /jobs/{id}/results or download CSV.
  6. Review costs, credits, or billing history when you need to reconcile spend.

​
Reference pages

Authentication

Use API keys, understand rate limits, and make retries safe with idempotency.

Integrations

Connect BrezelScraper to n8n and other automation tools with API keys and webhook configurations.

Jobs

Estimate, create, list, inspect, cancel, and delete scraping jobs.

Results and exports

Read paginated results, download CSV files, and inspect job costs.

Credits and billing

Read balances, fetch billing history, and start credit purchases.

Support

Submit support requests from an authenticated account.

​
Response conventions

  • Errors use a shared JSON shape:
{
  "code": 400,
  "message": "validation or request error details"
}
  • Most endpoints return JSON.
  • GET /jobs/{id}/download returns text/csv.