# Parameters

The Scraper API has the following parameters, only the token and url are mandatory, the rest are optional.

# token

  • Required
  • Type string

This parameter is required for all calls

This is your authentication token. All your requests must be authorized with your private token.

Private token

_USER_TOKEN_

Note: If you don't see your tokens, please login first here (opens new window) and then refresh this page.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.proxycrawl.com/scraper?token=_USER_TOKEN_&url=https%3A%2F%2Fwww.amazon.com%2Fdp%2FB00JITDVD2"

# url

  • Required
  • Type string

This parameter is required for all calls

You will need a url to crawl. Make sure it starts with http or https and that is fully encoded.

For example, in the following url: https://www.amazon.com/Jabra-Move-Wireless-Stereo-Headphones/dp/B00MR8Z28S/ the url should be encoded when calling the API like the following: https%3A%2F%2Fwww.amazon.com%2FJabra-Move-Wireless-Stereo-Headphones%2Fdp%2FB00MR8Z28S%2F

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.proxycrawl.com/scraper?token=_USER_TOKEN_&url=https%3A%2F%2Fwww.instagram.com%2Fp%2FB5LQhLiFFCX"

# country

  • Optional
  • Type string

If you want your requests to be geolocated from a specific country, you can use the &country= parameter, like &country=US (two-character country code).

Please check the list of supported countries in the Crawling API country parameter.

Geolocated scraping requests are available depending on your subscription. If your current subscription does not allow geolocated requests, then please upgrade your subscription.

# javascript

  • Optional
  • Type boolean

If you want your requests to render javascript in real chrome browsers, you can use the &javascript=true parameter. Please note that using the javascript parameter consumes 2 credits from your subscription total credits.

Browser enabled scraping requests are available depending on your subscription. If your current subscription does not allow javascript requests, then please upgrade your subscription.

# premium

  • Optional
  • Type boolean

If you want your requests to pass through the premium residential networks, you can use the &premium=true parameter. Please note that using the premium parameter consumes 10 credits from your subscription total credits. If you combine &premium=true with &javascript=true that consumes 20 credits from your subscription total credits.

Premium scraping requests are available depending on your subscription. If your current subscription does not allow premium requests, then please upgrade your subscription.