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

Runs and datasets

A run is one execution of a tool for your account (sync or async). A dataset is the structured output of that run — usually a list of JSON objects (rows).

Run resource (Platform)

curl -s "https://api.scrapy.infralyon.com/v1/runs/$RUN_ID" \
-H "Authorization: Bearer $SCRAPY_API_KEY" | jq .data

Typical fields:

FieldDescription
idRun id
kindapi_sync or async_batch
statusPublic status (see Sync vs async)
publisher / toolSlugTool identity when known
runNameOptional display name
totalItems / processedItems / completedItems / failedItemsProgress (async)
estimatedCost / billedAmountCost metadata
createdAt / completedAtTimestamps

Dataset items

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

Default JSON response:

{
"data": {
"items": [ { "...": "row fields depend on the tool" } ],
"total": 120,
"offset": 0,
"limit": 50
}
}

Row schemas differ per tool. Use tool datasetSchema / Store Output tab to understand fields.

Billing note

Scrapy.io meters successful results according to product rules (pay-per-result). Failed items are typically not billed the same way as successful rows — see console billing and the tool’s Store page for the exact policy.