v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-112650216.3 KB

Scrapers

Create scraper request

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 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."
  ]
}