Docs examples target https://api.scrapy.infralyon.com (not production https://api.scrapy.io).
Skip to main content

Runs

Base path: https://api.scrapy.infralyon.com/v1/runs

Auth required. All endpoints are owner-scoped to the API key’s account.


List runs

Request

GET /v1/runs
curl -s "https://api.scrapy.infralyon.com/v1/runs?kind=async_batch&status=succeeded&limit=20" \
-H "Authorization: Bearer $SCRAPY_API_KEY"

Query parameters

NameDescription
kindapi_sync, async_batch, or aliases api, scraper
toolIdFilter by internal tool id
statusPublic status; succeeded matches internal completed
offset / limitPagination

Response 200

{
"data": {
"items": [
{
"id": "…",
"kind": "async_batch",
"status": "succeeded",
"toolId": "…",
"publisher": "datadoping",
"toolSlug": "instagram-profile-scraper",
"runName": "ig-profiles-demo",
"totalItems": 3,
"processedItems": 3,
"completedItems": 3,
"failedItems": 0,
"billedAmount": 0.03,
"estimatedCost": 0.03,
"createdAt": "2026-09-07T10:00:00.000Z",
"completedAt": "2026-09-07T10:01:12.000Z"
}
],
"total": 1,
"offset": 0,
"limit": 20
}
}

Get run

Request

GET /v1/runs/{runId}
curl -s "https://api.scrapy.infralyon.com/v1/runs/$RUN_ID" \
-H "Authorization: Bearer $SCRAPY_API_KEY"

Response 200

{ "data": { …run fields… } }

Response 404

Unknown id or not owned by the caller.


Get dataset items

Request

GET /v1/runs/{runId}/dataset/items
# JSON envelope
curl -s "https://api.scrapy.infralyon.com/v1/runs/$RUN_ID/dataset/items?offset=0&limit=50" \
-H "Authorization: Bearer $SCRAPY_API_KEY"

# CSV file
curl -s "https://api.scrapy.infralyon.com/v1/runs/$RUN_ID/dataset/items?format=csv" \
-H "Authorization: Bearer $SCRAPY_API_KEY" \
-o out.csv

Query parameters

NameDescription
formatOmit or json for envelope; else csv, jsonl, xlsx, …
fields / omit / clean / descExport shaping
offset / limitWindow
attachmentControl Content-Disposition

See Export dataset.

Response 200 (JSON)

{
"data": {
"items": [ { } ],
"total": 50,
"offset": 0,
"limit": 50
}
}

Response 404

Run not found for this account.


Status values

queued · running · succeeded · partial · failed · cancelled