Parameters

Web Scraping API Parameters

Parameters supported by Core and Advanced solutions

Parameter

Header name

Default value

Description

Example

Core

url or query

n/a

null

Mandatory. Some target templates support query parameter, otherwise url is required.

https://ip.smartproxy.com

Supportsurl input

target

n/a

null

Necessary for some specific target templates

google_search

Supported with Advanced solution

headless

X-Smartproxy-Headless

null

Enable JavaScript rendering. Supported: – htmlpng

html

Supported with Advanced solution

geo

X-Smartproxy-Geo

auto-randomized

The geographical location that the result depends on. Read more

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

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

  • incorrect: united states
  • correct: United States

United States

Supported countries: US, CA, GB, DE, FR, NL, JP, RO

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

Supported with Advanced solution

headers

n/a

null

Adds request headers to the target request.

User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36

Supported with Advanced solution

cookies

n/a

null

Client cookie. Allows users to open up pages as if they are logged in.

Cookie: sessionid=8e1f3b56-7abc-47e6-b2e2-1d273b0a1c4d; logged_in=true; locale=en-US

Supported with Advanced solution

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

Supported with Advanced solution

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

Supported with Advanced solution

domain

n/a

com

com, co.uk,
fr, etc.

com

Supported with Advanced solution

device_type

X-Smartproxy-Device-Type

desktop

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

desktop

Supported with Advanced solution

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, so you have the choice to do the parsing on your end.

true

Supported with Advanced solution, Core returns HTML output

session_id

n/a

null

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

1234

Supported with Advanced solution

http_method

n/a

GET

Used to make a POST request instead of GET

POST

Supported with Advanced and Core solutions

payload

n/a

null

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

{foo: bar}

Supported with Advanced and Core solutions

successful_status_codes

n/a

null

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

401, 404

Supported with Advanced and Core solutions


Support

Need help or just want to say hello? Our customer support is available 24/7. You can also reach us anytime via email at [email protected].

Feedback

Can't find what you're looking for? Request an article!
Have feedback? Share your thoughts on how we can improve.