Platform API overview
Base URL:
https://api.scrapy.infralyon.com/v1
OpenAPI: platform-v1.yaml
What this API is for
| Capability | Endpoints |
|---|---|
| Discover tools | GET /tools, GET /tools/{publisher}/{slug} |
| Inspect runs | GET /runs, GET /runs/{runId} |
| Download results | GET /runs/{runId}/dataset/items |
| Automate | GET/POST/PATCH/DELETE /schedules |
What this API is not for
- Starting scrapes — use
{publisher}.p.scrapy.infralyon.com/.../v1/apior/v1/scraper - Account profile / “me” — use the console (out of scope for
/v1) - Webhooks — not in this version
Authentication
Authorization: Bearer scrapy_api_...
See Authentication.
Response envelopes
Single resource
{
"data": { }
}
Collection
{
"data": {
"items": [],
"total": 0,
"offset": 0,
"limit": 20
}
}
Error
{
"error": {
"type": "validation_error",
"message": "…",
"doc_url": "https://docs.scrapy.io/errors/validation-error"
}
}
See Errors.
Pagination
offset (default 0) and limit (default 20, max 100). See Pagination.
Resource map
/v1
├── /tools
│ └── /{publisher}/{slug}
├── /runs
│ └── /{runId}
│ └── /dataset/items
└── /schedules
└── /{scheduleId}