For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDKs

The ScraperAPI SDKs make it easy to use our API from your preferred programming language with minimal setup and maximum reliability.

Setup

Install the SDK that you prefer to use

pip install scraperapi-sdk
npm install scraperapi-sdk --save
composer require scraperapi/sdk
gem install scraperapi
# This example uses Maven for dependency management. Make sure you're familiar with Maven before continuing.
https://search.maven.org/artifact/com.scraperapi/sdk/1.2

Integrate it into your code

# Remember to install the library pip install scraperapi-sdk
from scraperapi_sdk import ScraperAPIClient
client = ScraperAPIClient('API_KEY')
result = client.get(url = 'https://example.com/')
print(result)
// remember to install the library: npm install scraperapi-sdk --save
import ScraperAPIClient from 'scraperapi-sdk';
const scraperapiClient = new ScraperAPIClient('API_KEY');

scraperapiClient.get('https://example.com/')
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });
# remember to install the library: composer require scraperapi/sdk
<?php
require __DIR__ . '/vendor/autoload.php';
use ScraperAPI\Client;

$client = new Client("API_KEY");
$result = $client->get("https://example.com/")->raw_body;

echo $result;

To enable extra functionality while using our SDKs, add an additional parameter to the GET request

# Remember to install the library pip install scraperapi-sdk
from scraperapi_sdk import ScraperAPIClient
client = ScraperAPIClient('API_KEY')
result = client.get(url = 'https://example.com/', params={'render': True})
print(result)
// remember to install the library: npm install scraperapi-sdk --save
import ScraperAPIClient from 'scraperapi-sdk';
const scraperapiClient = new ScraperAPIClient('API_KEY');

scraperapiClient.get('https://example.com/', {render: true})
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });
# remember to install the library: composer require scraperapi/sdk
<?php
require __DIR__ . '/vendor/autoload.php';
use ScraperAPI\Client;

$client = new Client("API_KEY");
$result = $client->get("https://example.com/", ["render" => true])->raw_body;

echo $result;

Use two or more parameters

# Remember to install the library pip install scraperapi-sdk
from scraperapi_sdk import ScraperAPIClient
client = ScraperAPIClient('API_KEY')
result = client.get(url = 'https://example.com/', params={'render': True, 'premium': True})
print(result)
// remember to install the library: npm install scraperapi-sdk --save
import ScraperAPIClient from 'scraperapi-sdk';
const scraperapiClient = new ScraperAPIClient('API_KEY');
const params = {render: true, country_code: 'us'};

scraperapiClient.get('https://example.com/', params)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });
# remember to install the library: composer require scraperapi/sdk
<?php
require __DIR__ . '/vendor/autoload.php';
use ScraperAPI\Client;

$client = new Client("API_KEY");
$result = $client->get("https://example.com/", ["render" => true, "country_code" => "us"])->raw_body;

echo $result;

Last updated