SERP Async
Authorization
BearerAuth In: header
Request Body
application/json
Request body model for the /serp endpoint
ISO Alpha-2 country code used to access the target search engine (e.g. US, DE, GB).
Device type used for the search request.
Value in
- "desktop"
- "mobile"
Top-level domain for the search engine (e.g. "com", "co.uk", "de").
"com"Locale used for the search request.
Geo-location for the search (canonical Google location name).
Number of results to return (1–100).
1 <= value <= 100The result page number for pagination.
1 <= value <= 9007199254740991When true, the SERP response is parsed into structured JSON.
trueThe search keyword or phrase to query.
Whether to render the page in a browser before extracting.
falseResolves redirect or broken URLs to their real destination. Adds a small increase in latency. If an individual result can't be resolved, that result falls back to the raw URL instead of failing the whole request.
falseThe search engine to query.
Value in
- "google_search"
- "google_sge"
- "google_aio"
- "google_maps_search"
- "google_maps_reviews"
- "google_maps_place"
- "google_news"
- "google_images"
- "bing_search"
- "yandex_search"
When true, disables Google result filtering (filter=0) so omitted/duplicate and highly similar pages are also returned. Applies to Google search engines.
URL to call back when async operation completes
Whether to compress stored data
Custom name for the stored object
Type of storage to use for results
URL for storage location
Response Body
application/json
curl -X POST "https://example.com/v2/serp/async" \ -H "Content-Type: application/json" \ -d '{ "search_engine": "google_search" }'{ "status": "success", "task": { "_query": null, "account_name": "string", "api_type": "web", "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc", "created_at": "2024-01-15T10:30:00Z", "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results", "error": "Connection timeout", "error_type": "timeout_error", "id": "123e4567-e89b-12d3-a456-426614174000", "input": null, "modified_at": "2024-01-15T10:35:00Z", "output_url": "string", "queue": "string", "state": "pending", "status_code": 200, "status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000" }}