On this page Overview

List classification batches

Read paginated batch summaries and current classification availability.

01 / Request

Make a request

GET/api/v1/scraping/classifications

Returns up to 10 batches, newest first, without items. Use offset=0, then 10, then 20 while hasMore is true. Concurrent new batches can shift pages; deduplicate by batch ID.

availability.enabled indicates whether new classification work is enabled and the starting balance/access requirements are met. Also check activeBatchId and the daily allowance. It does not promise that every source or model call will succeed.

Required headers

AuthorizationstringRequired: Bearer followed by your ScrapingBuddy customer API key.

Query parameters

offsetintegerOptional: Default 0. Integer from 0 to 100000. No configurable limit parameter.

GET /scraping/classifications

curl --fail-with-body -X GET "https://www.scrapingbuddy.com/api/v1/scraping/classifications?offset=0" \
  -H "Authorization: Bearer $SCRAPINGBUDDY_API_KEY"

GET /scraping/classifications

const apiKey = process.env.SCRAPINGBUDDY_API_KEY;
if (!apiKey) {
  throw new Error("Set the required environment variables before running.");
}

const response = await fetch(`https://www.scrapingbuddy.com/api/v1/scraping/classifications?offset=0`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${apiKey}`
  }
});
const data = await response.json();
if (!response.ok) {
  throw new Error(`${response.status}: ${data.error}`);
}
console.log(data);

GET /scraping/classifications

import os
import requests

api_key = os.environ["SCRAPINGBUDDY_API_KEY"]
response = requests.get(
    "https://www.scrapingbuddy.com/api/v1/scraping/classifications?offset=0",
    headers={
        "Authorization": f"Bearer {api_key}"
    },
    timeout=30,
)
data = response.json()
if not response.ok:
    raise RuntimeError(f"{response.status_code}: {data.get('error')}")
print(data)

Base URL https://www.scrapingbuddy.com/api/v1

Set SCRAPINGBUDDY_API_KEY in your server environment. JavaScript uses Node.js 20+; Python requires requests. These examples call the live, billed API.

02 / Response

Understand the response

Success returns HTTP 200 with JSON. Inspect item outcomes even when the batch is completed.

batchesarray: Up to 10 batch summaries, newest first, without items.
hasMoreboolean: If true, request the next page with offset increased by 10.
availabilityobject: enabled, dailyLimit, usedToday, activeBatchId, maxUrls, and billing (enabled, canStart, balanceUsd). Counters cover a rolling 24-hour window; balanceUsd is available credit after holds.

Batch and item fields

Example response / illustrative values

{
  "batches": [
    {
      "id": "f824e030-0e09-4d70-a372-fdfd22e84721",
      "status": "completed",
      "createdAt": "2026-10-09T10:00:00.000Z",
      "request": {
        "urls": [
          "https://example.com/about"
        ],
        "question": "Does this company offer managed web scraping services?",
        "choices": [
          "Yes",
          "No",
          "Maybe"
        ]
      },
      "total": 1,
      "completed": 1,
      "classified": 1
    }
  ],
  "hasMore": false,
  "availability": {
    "enabled": true,
    "dailyLimit": 100,
    "usedToday": 1,
    "activeBatchId": null,
    "maxUrls": 100,
    "billing": {
      "enabled": true,
      "canStart": true,
      "balanceUsd": "5.00"
    }
  }
}

URLs, IDs, costs, content and timestamps are illustrative. Use your own public hostname.

Errors & next steps

Request errors return an HTTP error status and a top-level error string. Processing failures appear in batch.items[].error even when fetching the result succeeds.

New tasks and batches require $1 available balance; insufficient starting credit returns 402. All customer keys share 60 requests per minute per account. For 429, honor Retry-After; active-task and daily limits may require a longer wait.

Errors & limits Safe retries Task lifecycle