Request detail
Return 404 for missing records and records owned by another key.
/v1/requests/{request_id}Request
https://api.scrapercompany.com/v1/requests/{request_id}Authenticate with your API key in the x-api-key header (see Authentication).
Parameters
- request_idstringpathrequired
Example request
curl "https://api.scrapercompany.com/v1/requests/req_0123456789abcdef0123456789abcdef" \
-H "x-api-key: $SCRAPERCOMPANY_API_KEY"Response
200 — One request record; records belonging to another API key return 404.
{
"id": "req_0123456789abcdef0123456789abcdef",
"method": "GET",
"path": "/v1/rates/stored",
"status": 200,
"duration_ms": 46,
"response_bytes": 9271,
"request": {
"query": {
"token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
"start": "2029-01-02",
"end": "2029-02-01"
}
},
"created_at": "2026-08-10 18:52:11.104922+00"
}Response fields
Fields marked required are always present; others appear when they apply.
- idstringrequired
req_...; equals thex-request-idresponse header. - methodstringrequired
- pathstringrequired
Route path, e.g.
/v1/calendar. - statusintegerrequired
- duration_msintegerrequired
- response_bytesintegerrequired
- requestobjectrequired
Sanitized request metadata; each key present only when the request had it.
Show 3 child fieldsHide child fields
- request.pathobject
Path parameters.
- request.queryobject
Query parameters (credentials redacted).
- request.bodyany
JSON body (credentials redacted), or
{truncated, bytes}/{invalid_json, bytes}.
- created_atstringrequired
Timestamp string, e.g.
2026-08-10 14:05:00.123456+00.
Errors
Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.
| Status | Meaning | Retry? |
|---|---|---|
401Unauthorized | Missing or invalid API key. {"detail":"missing or invalid API key"} | No, fix the request |
404Not Found | The property, stay, job or record was not found. {"detail":"job not found"} | No, fix the request |
422Unprocessable Content | Request validation failed. {"detail":[{"loc":["body","token"],"msg":"Field required","type":"missing"}]} | No, fix the request |
429Too Many Requests | Too many requests: the key's requests-per-minute limit was exceeded, or (once credit enforcement is on) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry. {"detail":"rate limit 60/min exceeded"} | Yes, with backoff |
503Service Unavailable | Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. {"detail":"database unavailable: OperationalError"} | Yes, with backoff |
Try it
- Export your key:
export SCRAPERCOMPANY_API_KEY=sk_...(no key yet? request access). - Copy the cURL example above and run it in a terminal.
- Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.