OpenAPI & AsyncAPI

Prefer generated clients and imported collections over hand-written HTTP calls? Everything on this docs site is also available as machine-readable contracts, generated from the same code that serves the API - they cannot drift. For Python and Node.js there are ready official SDKs, generated from this document.

REST API (OpenAPI 3)

Resource	URL
Interactive reference (Swagger UI)	https://api.scrapeit.io/api/reference
OpenAPI JSON	https://api.scrapeit.io/api/openapi.json
OpenAPI YAML	https://api.scrapeit.io/api/openapi.yml

The document covers the public workspace surface only - the Web Scraping API (sync and async), batch, crawler, the Google SERP, Google Maps, Amazon, Walmart, Booking.com, Yelp, Redfin, Airbnb, Tripadvisor, Yellow Pages, Allegro, Apartments.com and Zillow product APIs with their bulk jobs, files, webhooks, usage, job monitoring and the public status endpoint - with the x-api-key and bearer security schemes (authentication).

Import & codegen recipes

Postman / Insomnia

# Import → Link → paste:
https://api.scrapeit.io/api/openapi.json

openapi-generator

openapi-generator-cli generate \
  -i https://api.scrapeit.io/api/openapi.yml \
  -g typescript-fetch \
  -o ./scrapeit-client

curl (save locally)

curl -o scrapeit-openapi.yml https://api.scrapeit.io/api/openapi.yml

Webhook events (AsyncAPI 3)

Resource	URL
AsyncAPI YAML	https://api.scrapeit.io/api/asyncapi.yml

Describes every webhook event type, the delivery envelope, the x-scrapeit-signature / x-scrapeit-timestamp signature headers and the retry schedule. Render it visually in AsyncAPI Studio by pasting the URL.

Related pages

• Requests & responses - the envelope every endpoint shares.
• Error codes - stable codes referenced by the spec.