S E R P

SERP

POST
/v2/serp

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

Request body model for the /serp endpoint

country?string

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

device?string

Device type used for the search request.

Value in

  • "desktop"
  • "mobile"
domain?string

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

Default"com"
locale?string

Locale used for the search request.

location?string

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

num_results?integer

Number of results to return (1–100).

Range1 <= value <= 100
page?integer

The result page number for pagination.

Range1 <= value <= 9007199254740991
parse?boolean

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

Defaulttrue
query?string

The search keyword or phrase to query.

render?boolean

Whether to render the page in a browser before extracting.

Defaultfalse
resolve_url?boolean

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.

Defaultfalse
search_engine*string

The 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"
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.

Response Body

application/json

curl -X POST "https://example.com/v2/serp" \  -H "Content-Type: application/json" \  -d '{    "search_engine": "google_search"  }'
{  "data": {    "browser_actions": {      "results": [        {          "duration": 0,          "error": "string",          "name": "goto",          "result": null,          "status": "no-run"        }      ],      "success": true,      "total_duration": 0    },    "cookies": [      null    ],    "eval": [      null    ],    "fetch": [      null    ],    "headers": {      "property1": "string",      "property2": "string"    },    "html": "string",    "links": [      "string"    ],    "markdown": "string",    "network_capture": [      {        "errorMessage": "string",        "filter": {          "method": "GET",          "resource_type": "document",          "status_code": 100,          "url": {            "type": "exact",            "value": "string"          },          "validation": false,          "wait_for_requests_count": 0,          "wait_for_requests_count_timeout": 1        },        "results": [          {            "request": {              "body": "string",              "headers": {                "property1": "string",                "property2": "string"              },              "method": "string",              "resource_type": "document",              "url": "string"            },            "response": {              "body": "string",              "headers": {                "property1": "string",                "property2": "string"              },              "serialization": "none",              "status": 0,              "status_text": "string"            }          }        ]      }    ],    "pages_html": [      "string"    ],    "parsing": {      "entities": {        "property1": null,        "property2": null      },      "status": "success"    },    "redirects": [      {        "status_code": 100,        "url": "string"      }    ],    "screenshots": [      null    ]  },  "debug": {    "performance_metrics": {      "property1": 0,      "property2": 0    },    "proxy_total_bytes_usage": 0,    "transformed_output": null,    "userbrowser": null  },  "metadata": {    "agent": "string",    "driver": "string",    "localization_id": "string",    "query_duration": 0,    "query_time": "string",    "response_parameters": null,    "tag": "string"  },  "pagination": {    "next_page_params": {      "property1": null,      "property2": null    }  },  "status": "success",  "status_code": 0,  "task_id": "string",  "url": "string",  "warnings": [    "string"  ]}