Access the API

Accessing the WB Custom Scraping API is as simple as sending a GET request to our endpoint.

The WB Custom API is available via POST requests sent to our official API endpoint and by specifying the engine=<WB_ENGINE> query parameter alongside the 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=<WB_ENGINE>&type=product

• Engine Selection: Specify the platform you wish to scrape using the engine parameter. Supported engines include wayfair_async, bestbuy_async, and nordstrom_async.

You can use this as the base URL for the WB Custom API: https://ecom.webscrapingapi.com/v1?api_key=<YOUR_API_KEY>&engine=<WB_ENGINE>&type=product

• Request Body: The body should be a JSON object containing the necessary parameters, such as search queries, filters, or product identifiers, depending on your scraping requirements. Here’s an example request body for retrieving product details:

Name	Type	Description
url	string	https://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

Our WB Custom API requires an API key for authentication. The key is embedded in the URL as a query parameter called api_key and has to be included on each GET request, for the request to pass. Failing to pass the required api_key parameter or passing an incorrect key will result in an Unauthorized HTTP status.

To obtain an API key for the WB Custom API, you have to:

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 all supported engines: Wayfair, Best Buy and Nordstrom.

In the following documentation, we will refer to the API key by using this syntax:<YOUR_API_KEY>

Please make sure to store your private API key in a secure location and never make it publicly available. Using the API key directly impacts you subscription plan.