Skip to main content
POST
SERP

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body model for the /serp endpoint

search_engine
enum<string>
required

The search engine to query.

Available options:
google_search,
google_sge,
google_aio,
google_maps_search,
google_maps_reviews,
google_maps_place,
google_news,
google_images,
bing_search,
yandex_search
Example:

"google_search"

country
string

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

Example:

"US"

device
enum<string>

Device type used for the search request.

Available options:
desktop,
mobile
Example:

"desktop"

domain
string
default:com

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

Example:

"com"

locale
string

Locale used for the search request.

Example:

"en"

location
string

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

Example:

"New York, New York, United States"

num_results
integer

Number of results to return (1–100).

Required range: 1 <= x <= 100
Example:

10

page
integer

The result page number for pagination.

Required range: 1 <= x <= 9007199254740991
Example:

1

parse
boolean
default:true

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

Example:

true

query
string

The search keyword or phrase to query.

Example:

"nimble web data"

render
boolean
default:false

Whether to render the page in a browser before extracting.

Example:

false

resolve_url
boolean
default:false

Resolves 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.

Example:

false

show_hidden_results
boolean

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

Example:

false

Response

200 - application/json

Successful Response

data
object
required
metadata
object
required
status
enum<string>
required

The status of the task.

Available options:
success,
skipped,
fatal,
error,
postponed,
ignored,
rejected,
blocked
task_id
string
required

Unique identifier for the task.

url
string
required

The final URL.

debug
object
pagination
object

Pagination information if applicable.

status_code
number

The HTTP status code of the task.

warnings
string[]

List of warnings generated during the task.