WebScrapingAPI Docs
Retailer APIsTarget Search APIGetting Started

Access the API

Access the Target API endpoint for ecommerce data requests.

Use this endpoint for product requests, discovery, and snapshot retrieval:

https://ecom.webscrapingapi.com/v1
ActionMethodQuery parameters
Collect one product or discovery inputGETapi_key, engine=target, type=product, and input fields.
Collect a batchPOSTapi_key, engine=target, type=product; inputs go in a JSON array body.
Submit in the backgroundGET or POSTAdd async=true or use engine=target_async.
Check job progressGETapi_key, engine=target, type=progress, snapshot_id.
Retrieve a completed jobGETapi_key, engine=target, type=snapshot, snapshot_id.

Snapshot retrieval also supports the shared polling endpoint with only api_key and snapshot_id. See the async workflow for complete submission and polling examples.

The API key

Authorize requests by passing the required api_key parameter. After registration, subscribe to the Target API in the dashboard and use a key with access to that service. Use the same key when retrieving its snapshots.

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