Olostep · Web Data

Olostep / Batch scrape (start)

Initiates a new batch process with the specified parameters.

Live data

You are looking at the live public catalog.

unverifiedRequest shape unavailableUnverified

Published API evidence

Public metadata only. Response bodies, credentials, and internal review notes are never displayed.

No verification date is claimed. No response capture is claimed.

Request parameters

country body · optional
Country for the batch execution. Provide in ISO 3166-1 alpha-2 codes like US(USA), IN(India), etc
items body · required
Array of items to be processed in the batch.
links_on_page body · optional
Get all the links present on each page in the batch. Links are always returned as absolute URLs.
metadata body · optional
Set of key-value pairs for storing additional information about an object. Follows Stripe's approach with validation rules: max 50 keys, key max 40 characters (no square brackets), value max 500 characters, all values stored as strings.
parser body · optional
You can use this parameter to specify the parser to use. Parsers are useful to extract structured content from web pages. Olostep has a few parsers built in for most common web pages, and you can also create your own parsers.
webhook body · optional
HTTPS URL to receive a POST request when the batch completes. Must be a publicly accessible URL using `http://` or `https://` protocol. Cannot point to localhost or private IP addresses. See [Webhooks](/api-reference/common/webhooks) for payload format and retry behavior.