Sign in

v1

latestOpenAPI 3.1.02026-07-2658119246.0 KB
SERP

SERP Async

post/v2/serp/async

Request body

countrystring

ISO Alpha-2 country code used to access the target search engine (e.g. US, DE, GB).

device'desktop' | 'mobile'

Device type used for the search request.

domainstring

Top-level domain for the search engine (e.g. "com", "co.uk", "de").

localestring

Locale used for the search request.

locationstring

Geo-location for the search (canonical Google location name).

num_resultsinteger

Number of results to return (1–100).

pageinteger

The result page number for pagination.

parseboolean

When true, the SERP response is parsed into structured JSON.

querystring

The search keyword or phrase to query.

renderboolean

Whether to render the page in a browser before extracting.

search_engine'google_search' | 'google_sge' | 'google_aio' | 'google_maps_search' | 'google_maps_reviews' | 'google_maps_place' | 'google_news' | 'google_images' | 'bing_search' | 'yandex_search' required

The search engine to query.

show_hidden_resultsboolean

When true, disables Google result filtering (filter=0) so omitted/duplicate and highly similar pages are also returned. Applies to Google search engines.

callback_urlstring

URL to call back when async operation completes

storage_compressboolean

Whether to compress stored data

storage_object_namestring

Custom name for the stored object

storage_typestring

Type of storage to use for results

storage_urlstring

URL for storage location

Example request

{
  "country": "US",
  "device": "desktop",
  "domain": "com",
  "locale": "en",
  "location": "New York, New York, United States",
  "num_results": 10,
  "page": 1,
  "parse": true,
  "query": "nimble web data",
  "search_engine": "google_search",
  "callback_url": "https://example.com/webhook/callback",
  "storage_compress": true,
  "storage_object_name": "result-2024-01-15.json",
  "storage_type": "s3",
  "storage_url": "s3://bucket-name/path/to/object"
}

Response

Task created successfully

status'success' required

Status indicating the async SERP task was created successfully.

Example response

{
  "task": {
    "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",
    "modified_at": "2024-01-15T10:35:00Z",
    "state": "pending",
    "status_code": 200,
    "status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000"
  }
}