WebScrapingAPI Docs

Access the API

Access the WB Custom API endpoint for async batch requests.

The WB Custom API accepts POST requests with engine=<WB_ENGINE> in the query string and engine-specific inputs in the JSON body.

The official WB Custom API endpoint is:

  • https://ecom.webscrapingapi.com/v1

Making a POST request

When making a POST request, include the following components:

  • API Key: Add your unique API key as a query parameter in the URL:
    https://ecom.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&engine=bestbuy_async&type=product
  • Engine Selection: Specify the batch engine with the engine parameter. Supported engines include wayfair_async, bestbuy_async, nordstrom_async, booking_async, and chatgpt_async.

You can use this as a base URL for a product scraping request: https://ecom.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&engine=bestbuy_async&type=product

  • Request body: Send a JSON array with the inputs required by the selected engine, such as URLs, search queries, filters, or prompt configuration. For example:
NameTypeDescription
urlstringhttps://www.example.com
[
  {
    "url": "https://www.example.com"
  },
  {
    "url": "https://www.example2.com"
  }
]

After submitting a POST request, you will receive a snapshot_id in the response. This snapshot_id can be used to retrieve the processed results at a later time.

Accessing the Snapshot API

The Snapshot API allows you to retrieve results from a previously submitted POST request using the snapshot_id. This feature is useful for asynchronous processing and ensures that you can access data when it is ready.

  • Snapshot API Endpoint:
    https://ecom.webscrapingapi.com/v1
  • Required Parameters:
    • api_key: Your unique API key.
    • snapshot_id: The ID returned from the POST request.
  • Example GET Request:
GET https://ecom.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&snapshot_id=<SNAPSHOT_ID>

The response will include the results associated with the snapshot_id in JSON format.

The API key

WB Custom API requests authenticate with the api_key query parameter. Requests without a valid key return 401 Unauthorized.

To obtain an API key for the WB Custom API:

  1. Register a new account on our official platform
  2. Get access to this service upon request

Subscription to the WB Custom API gives you access to the supported async batch engines enabled for your account.

Examples use <YOUR_API_KEY> as the API key placeholder.

Keep API keys in server-side secrets. Do not ship them in browser code, mobile apps, public repositories, logs, screenshots, or shared notebooks.

On this page