Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011235801.3 MB
SERP

SERP

post/v1/serp

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.

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"
}

Response

Successful Response

status'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked' required

The status of the task.

status_codenumber

The HTTP status code of the task.

task_idstring required

Unique identifier for the task.

urlstring required

The final URL.

warningsstring[]

List of warnings generated during the task.

Example response

{
  "data": {
    "network_capture": [
      {
        "filter": {
          "resource_type": "document"
        },
        "results": [
          {
            "request": {
              "resource_type": "document"
            }
          }
        ]
      }
    ]
  }
}