Scrapers

Get scraper request

Returns current status for a scraper Request.

get/v1/requests/{request_id}

Path parameters

request_idstring required

Example:request_123

Scraper Request id.

Response

Scraper request loaded.

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

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

Jul 2, 2026c7b37eaf7c3818See the full diff
- ▲
  removed the required property ok from the response with the 200 status
  response-required-property-removed
- ○
  added the required property nextActions to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/agentInstruction to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/costUsdMicros to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/errorMessage to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/estimatedCostUsdMicros to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/resultCount to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/resultsUrl to the response with the 200 status
  response-required-property-added
- ○
  added the required property request/updatedAt to the response with the 200 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