v50

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

Scrapers

List scraper requests

Lists recent paid scraper Requests for the authenticated account.

get/v1/requests

Query parameters

limitinteger

Example:50

Maximum number of scraper Requests to return. Context $.paths./v1/requests.get.parameters.0.

cursorstring

Example:example

Opaque pagination cursor from a previous response. Context $.paths./v1/requests.get.parameters.1.

Response

Scraper requests loaded.

nextCursorstring nullable required

nextActionsstring[] required

Example response

{
  "requests": [
    {
      "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"
    }
  ],
  "nextCursor": null,
  "nextActions": [
    "Use `nextCursor` with `tovuk request list --cursor <nextCursor> --json` when another page exists."
  ]
}