Parameters

All Scraper APIs support the parameters listed in this page. Note that each individual target may have custom parameters.

Parameter

Header name

Default value

Description

Example

target

n/a

Each Scraping API supports a number of targets. This parameter is always required, along with either url or query.

See targets supported by SERP Scraping APIs for examples.

google_search

headless

X-Smartproxy-Headless

null

Enable JavaScript rendering.
Supported:
– html
– png

html

geo

X-Smartproxy-Geo

auto-randomized

The geographical location that the result depends on.

– City location names
– State names
– Country names
– Coordinates and Radius
– Google’s Canonical
– Location Name. Read more here.

⚠️ When providing a country name, must be in Capital Case:

  • incorrect: united states
  • correct: United States

United States

locale

n/a

Matched with domain parameter

This will change the search page web interface language (not the results).
Example:
– en-US
– en-GB

en-gb

headers

n/a

null

Adds requests headers to the target request.

cookies

n/a

null

Client cookie. Allows opening up pages as if the user is logged in.

force_cookies

n/a

false

By default, user-provided cookies are not forwarded to the target. Set this parameter to true to override this behaviour.

true

force_headers

n/a

false

By default, user-provided headers are not forwarded to the target. Set this parameter to true to override this behaviour.

true

domain

n/a

com

  • *com**,co.uk,**fr**, etc.

com

device_type

X-Smartproxy-Device-Type

desktop

Device type and browser.
Supported:
– desktop
– desktop_chrome
– desktop_firefox
– mobile
– mobile_android
– mobile_ios

desktop

parse

X-Smartproxy-Parse

false

When set to true, if the selected target supports parsing, we will parse the result on our end using our selectors. This will, however, omit some information out, so you have the choice to do the parsing on your end.

true

session_id

n/a

Session to re-use the same IP for multiple requests for up to 10 minutes

1234

http_method

n/a

Used to make a POST request instead of GET

POST

payload

n/a

Base64 encoded POST request body. Used when http_method is POST.

{foo: bar}

successful_status_codes

n/a

Define one or more HTTP response codes you consider successful and want to get the content for.

401, 404