Platform API overview

Use this section to look up an endpoint. To run a scraper for the first time, start at Getting started and follow Run scrapers in the sidebar.

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}, GET /tools/{publisher}/{slug}/readme, GET /tools/{publisher}/{slug}/reviews
Credits	GET /account
Inspect runs	GET /runs, GET /runs/{runId}
Stop or continue a batch	POST /runs/{runId}/abort, POST /runs/{runId}/resume
Download results	GET /runs/{runId}/dataset/items
Spend	GET /usage
Automate	GET/POST/PATCH/DELETE /schedules

What this API is not for

• Starting scrapes — use {publisher}.p.scrapy.infralyon.com/.../v1/api or /v1/scraper
• Account profile (email, avatar, API key regeneration) — use the console. GET /account returns credits and whether a run is allowed, not the profile.
• Webhooks — not in this version

Account and usage

curl -s "https://api.scrapy.infralyon.com/v1/account" -H "x-api-key: $SCRAPYIO_API_KEY"
curl -s "https://api.scrapy.infralyon.com/v1/usage?from=2026-09-01&to=2026-09-28&limit=5" \
  -H "x-api-key: $SCRAPYIO_API_KEY"

GET /account returns usageAllowed, usageStatus, credit totals, and the current billing cycle. It does not return email or the API key.

GET /usage returns spend and run counts for the range, plus topTools (1–10, default 5). Invalid from / to / limit returns 400.

Authentication

x-api-key: sc_...

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
├── /account
├── /usage
├── /tools
│   └── /{publisher}/{slug}
│       ├── /readme
│       └── /reviews
├── /runs
│   └── /{runId}
│       ├── /abort
│       ├── /resume
│       └── /dataset/items
└── /schedules
    └── /{scheduleId}

Detailed reference

• Tools
• Find a scraper — publisher, slug, and one sample call
• Runs
• Schedules
• Errors