Using the API Endpoint

Making a request to the Sync API is straightforward. You send a request, and we take care of proxies, browsers, CAPTCHAs, and protections in the background.

Base URL

https://api.scraperapi.com

Required query parameters

api_key - your API Key
url - target URL

Sample Request

curl --request GET \
--url 'https://api.scraperapi.com?api_key=API_KEY&url=https://www.example.com'

import requests

#Target URL
target_url = 'https://www.example.com'
# ScraperAPI API Key
api_key = 'API_KEY'

request_url = f'https://api.scraperapi.com?api_key={api_key}&url={target_url}'
response = requests.get(request_url)

print(response.text)

import request from 'node-fetch';

//Replace the value for api_key with your actual API Key
const url = 'http://api.scraperapi.com/?api_key=API_KEY&url=https://example.com/';

request(url)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });

<?php

//Replace the value for api_key with your actual API Key
$url = "http://api.scraperapi.com?api_key=API_KEY&url=https://example.com/";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
} else {
    print_r($response);
}

curl_close($ch);

require 'net/http'

#Replace the value for api_key with your actual API Key
params = {
  api_key: "API_KEY",
  url: "https://www.example.com/"
}

uri = URI('https://api.scraperapi.com/')
uri.query = URI.encode_www_form(params)

website_content = Net::HTTP.get(uri)
puts website_content

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        //Replace the value for api_key with your actual API Key
        String apiKey = "API_KEY";
        String targetUrl = "https://www.example.com/";

        String scraperApiUrl = "https://api.scraperapi.com?api_key=" + apiKey + "&url=" + targetUrl;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(scraperApiUrl))
                .GET()
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Optional Parameters

Sometimes sending normal (flat) requests is not enough, either because the domain is geo-locked to a specific region, it requires JavaScript rendering or it employs stronger bot protection. In those cases, you can add extra ScraperAPI parameters to your requests to ensure you get the data you need. Here are some common examples:

render=true - enables JavaScript Rendering with the request.
country_code=us - get results from a specific region. For the complete list of supported countries, visit this page.
premium=true - instructs the API to use high-quality residential proxies.
session_number=123 - keep reusing the same IP across multiple requests. Sessions expire 15 minutes after the last usage.

Here's an example request with JavaScript Rendering enabled

curl --request GET \
--url 'https://api.scraperapi.com?api_key=API_KEY&render=true&url=https://www.example.com'

import requests

target_url = 'https://www.example.com'
# Replace the value for api_key with your actual API Key.
api_key = 'API_KEY'

request_url = f'https://api.scraperapi.com?api_key={api_key}&render=true&url={target_url}'
response = requests.get(request_url)

print(response.text)

import request from 'request-promise';

//Replace the value for api_key with your actual API Key.
const url = 'https://api.scraperapi.com/?api_key=API_KEY&render=true&url=https://example.com/';

request(url)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });

<?php

//Replace the value for api_key with your actual API Key.
$url = "https://api.scraperapi.com?api_key=API_KEY&render=true&url=https://example.com/";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
} else {
    print_r($response);
}

curl_close($ch);

require 'net/http'
require 'json'


params = {
  # Replace the value for api_key with your actual API Key.
  api_key: "API_KEY",
  render: "true",
  url: "https://www.example.com/"
}

uri = URI('https://api.scraperapi.com/')
uri.query = URI.encode_www_form(params)

website_content = Net::HTTP.get(uri)
print website_content

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        //Replace the value for api_key with your actual API Key.
        String apiKey = "API_KEY";
        String targetUrl = "https://www.example.com/";

        String scraperApiUrl = "https://api.scraperapi.com?api_key=" + apiKey + "render=true" + "&url=" + targetUrl;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(scraperApiUrl))
                .GET()
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Note: Ensure that all ScraperAPI parameters are listed before the url parameter, to avoid conflicts with paramters that may already exist in the target URL.

Supported Geolocations.

Full list of supported parameters.

PreviousOverview NextProxy Port Method

Last updated 2 days ago

hashtagBase URL

hashtagRequired query parameters

hashtagSample Request

hashtagOptional Parameters

hashtagRelated Sections

Base URL

Required query parameters

Sample Request

Optional Parameters

Related Sections