Reference

API reference

This is the full list of routes that a Read or Full key can call. Each route shows its fields, its answers and an example. For how to call them (address, header, paging, limits), start with API basics.

Open the API reference. Use the search box at the top left to find a route by name.
Click a route to see its fields and its answers. The right side shows an example request and answer.
To call a route, make a key first. Press your name at the bottom of the portal menu, then API Keys, and make a Read key to look or a Full key to change things. See API keys.

Download the OpenAPI file: openapi-customer.json. It lists only the routes a Read or Full key can call. You need no key to download it.
Load it into a client generator or an API tool. The calls it makes use your Read key or Full key. The server address in the file is https://portal.scrapewise.ai/api/scraper-api.
Send your key in the Authorization: Bearer YOUR_KEY header on every call. A Read key can call the routes that only read. A Full key can call every route in the file.
When this page and the file disagree, the file is right. The file is rebuilt from the live API each time these docs are published.

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.scrapewise.ai/openapi-customer.json \
  -g typescript-fetch -o ./scrapewise-client

Questions

Is there a separate version number in the address?

No. There is one current API. We add fields and routes. If a change would break your code, we add a new field or route first and keep the old one for a while.

Where do I see what changed?

In the Changelog. Every release that adds, removes or changes a route is listed there.

A route I use is not in the reference.

The reference lists the routes a Read or Full key can call. Sign-in, top-up and key management belong to the portal and are not part of the API.

Last updated 20 May 2026