ScrapingDuck API Docs
    • Actions
      • Returns example action objects for each available action.
        GET
    • Browser
      • Executes a list of browser actions.
        POST
      • Fetches the full HTML content of a web page.
        GET
      • Extracts the main article content from a web page.
        GET
    • Devices
      • Gets the list of all available device names.
      • Gets detailed information for a specific device.
    • Scrape
      • Fetches the raw HTML source of a web page as a direct text/html response.
      • Fetches the full scraping result including HTML content and metadata (JSON response).
      • Extracts the main article content from a web page.
      • Extracts the main article content as Markdown-friendly text.
      • Captures a screenshot of a web page as a binary image.
      • Submits a batch of URLs for asynchronous scraping. Returns 202 Accepted with a batch ID immediately. Results are delivered via webhook callback or polled via GET /v1/scrape/batch/{batchId}.
      • Polls the status of a previously submitted batch scrape job. Results are retrieved from the webapp's persistent storage.
    • Billing
      • Estimates the credit cost of a browser automation request without executing it.
      • Estimates the credit cost of a batch scrape without reserving credits.
    • Search
      • Performs a web search and returns unified results from SearXNG, TinyFish or Brave Search.
    • Sessions
      • Opens a new interactive browser session. Creating a session is free; each step is billed.
      • Lists the caller's active sessions.
      • Gets a session's metadata and current page snapshot.
      • Closes the caller's session. Idempotent: always returns 204.
      • Executes a single browser action in the caller's live session.
    • Schemas
      • ActionExecutionMeta
      • BrowserAction
      • BatchItemResult
      • BrowserActionResult
      • BatchScrapeRequest
      • BrowserActionResultActionExecutionResponse
      • BatchScrapeResponse
      • BrowserAutomationRequest
      • BatchWebhookMeta
      • DeviceContextOptionsDto
      • BatchWebhookPayload
      • BillingEstimateResponse
      • DeviceDetailDto
      • ProblemDetails
      • PublicBrowserAutomationRequest
      • ResultData
      • BrowserActionResultSessionStepResponse
      • ValidationProblemDetails
      • ViewSettings
      • SearchResponse
      • SearchResultItem
      • SessionOpenedResponse
      • SessionSummaryDto
      • TrafficSource
    ScrapingDuck

    BatchWebhookPayload

    Payload sent to the webhook URL on batch completion.

    {
    "batchId": "string",
    "status": "string",
    "totalUrls": 0,
    "succeededCount": 0,
    "failedCount": 0,
    "results": [
        {
            "url": "string",
            "success": true,
            "statusCode": 0,
            "error": "string",
            "html": "string",
            "title": "string",
            "contentLength": 0,
            "durationMs": 0
        }
    ],
    "meta": {
        "totalDurationMs": 0,
        "totalCostCredits": 0,
        "startedAtUtc": "2019-08-24T14:15:22.123Z",
        "finishedAtUtc": "2019-08-24T14:15:22.123Z"
    }
}
    Built with