Scrapers

List scraper result records

Returns stored JSON Records for a completed scraper Request.

get/v1/requests/{request_id}/results

Path parameters

request_idstring required

Example:request_123

Scraper Request id. Context $.paths./v1/requests/{request_id}/results.get.parameters.0.

Query parameters

limitinteger

Example:100

Maximum number of items to return. Context $.paths./v1/requests/{request_id}/results.get.parameters.1.

cursorstring

Example:example

Opaque pagination cursor from a previous response. Context $.paths./v1/requests/{request_id}/results.get.parameters.2.

Response

Scraper results loaded.

nextCursorstring nullable required

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"
  },
  "records": [
    {
      "index": 0,
      "data": {
        "id": "video_123",
        "desc": "rust programming"
      },
      "sizeBytes": 64,
      "createdAt": "2026-06-23T12:00:30Z"
    }
  ],
  "nextCursor": null,
  "nextActions": [
    "Use `nextCursor` with `tovuk request results request_123 --cursor <nextCursor> --json` when another page exists."
  ]
}

Changes

Changed in 2 of the 50 revisions of this API.215

Jul 2, 2026c7b37eaf7c38214See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ●
  changed the pattern of the query request parameter cursor from ^[\s\S]{0,8192}$ to ^[\s\S]{1,512}$
  request-parameter-pattern-changed
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 5, 20263985c6090c911See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 141 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history