OpenAPI

Every platform publishes an OpenAPI 3.1 file with its endpoints, so you can generate a typed client or import the API into a tool such as Postman.

Download it

Each platform's file is on its reference page, under "At a glance", and at a stable address:

https://docs.upscrape.com/docs/platforms/PLATFORM_ID/openapi.json

Each endpoint also has a file of its own, at its reference page's address plus /openapi.json, for when you only need one.

What it holds

• POST /execute with every endpoint of the platform: its ID and its input, as JSON Schema.

• GET /jobs/{id} to fetch a job.

• The Authorization: Bearer key, and the Prefer, Idempotency-Key and X-Max-Credits headers.

• The rate-limit headers and every error, with its code.

• The shape of each endpoint's data, where it can be written down exactly.

The file lists addresses without /v1; every address also works with it.

Keep up to date

The file always matches the endpoints that are live today. Download it again when you update your integration, and let your generated client ignore fields it does not know: an endpoint can gain fields.