Scrapers

Create scraper request

Changed on

Creates paid public-data scraper work. Inputs must not include cookies, passwords, private session data, private account content, private repository credentials, or proxy URLs.

post/v1/requests

Request

  • Base URL
    https://api.tovuk.com
  • Auth
    HTTP bearer

Request body

scraperstring required
inputobject required

Public Scraper input. Do not send cookies, passwords, account tokens, private session data, private account content, private repository credentials, or proxy URLs.

Example request

{
  "scraper": "github",
  "input": {
    "query": "language:rust topic:scraper"
  }
}

Response

Scraper request created.

nextActionsstring[] required

Example response

{
  "request": {
    "id": "request_123",
    "scraper": "tiktok",
    "status": "succeeded",
    "input": {
      "operation": "search",
      "query": "rust programming",
      "limit": 100
    },
    "resultCount": 1,
    "estimatedCostUsdMicros": 170000,
    "costUsdMicros": 1700,
    "resultsUrl": "/v1/requests/request_123/results",
    "errorMessage": null,
    "agentInstruction": "Fetch results with `tovuk request results request_123 --json`.",
    "createdAt": "2026-06-23T12:00:00Z",
    "updatedAt": "2026-06-23T12:00:30Z"
  },
  "nextActions": [
    "Use `tovuk request results request_123 --json` after the request succeeds."
  ]
}

Changes

    • warning

      the request property's maxLength was set to 64

    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status