SOAX

https://helpcenter.soax.com/en
Admin
SOAX is a proxy service provider offering residential, mobile, and datacenter proxies with web data...
Tokens:41,037
Snippets:454
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Selenium IP Authorization Proxy Setup (Python)

Source: https://helpcenter.soax.com/en/articles/6349300-selenium

Python example demonstrating how to connect Selenium WebDriver to a proxy using IP authorization. It configures Chrome options to use the specified proxy server and port, then navigates to a target URL.

```python
from selenium import webdriver   
PROXY = "proxy.soax.com:10000"   
chrome_options = webdriver.ChromeOptions()  
chrome_options.add_argument('proxy.soax.com' % PROXY) 
chrome = webdriver.Chrome(chrome_options=chrome_options) 
chrome.get("https://www.google.com")
```

--------------------------------

### .NET C# Proxy Setup with Rebex HTTP

Source: https://helpcenter.soax.com/en/articles/4830123-proxy-set-up-using-curl-php-net-with-c-or-python

Demonstrates how to configure and use a SOCKS5 proxy with the Rebex HTTP library in .NET. It includes setting proxy details like host, port, username, and password, and making an HTTP GET request to a checker API.

```csharp
using Rebex.Net;  
using System;  
using System.Collections.Generic;  
using System.IO;  
using System.Linq;  
using System.Text;  
using System.Threading.Tasks;  
  
namespace ConsoleApp1  
{
    class Program  
    {
        static void Main(string[] args)  
        {
            Rebex.Licensing.Key = "ENTER YOUR LICENSING KEY HERE";  

            var client = new Rebex.Net.HttpRequestCreator();  
              
            client.Proxy.ProxyType = ProxyType.Socks5;  
            client.Proxy.Host = "proxy.soax.com";  
            client.Proxy.Port = 9000;  
            client.Proxy.UserName = "0YFEkZzfrwBX4Wfp";  
            client.Proxy.Password = "wifi;us;;;";  

            var url = "http://checker.soax.com/api/ipinfo";  

            var httpRequest = client.Create(url);  
            httpRequest.Headers["Accept"] = "text/html, application/xhtml+xml, image/jxr, */*";  
            httpRequest.Headers["Accept-Language"] = "en-US,en;q=0.7,ru;q=0.3";  
            httpRequest.Headers["Accept-Encoding"] = "gzip, deflate";  
            httpRequest.Headers["Host"] = url;  
            httpRequest.Headers["Connection"] = "Keep-Alive";  
            httpRequest.Timeout = 30000;  
              
            try  
            {
                var response = httpRequest.GetResponse() as Rebex.Net.HttpResponse;  

                using (StreamReader sr = new StreamReader(response.GetResponseStream()))  
                {
                    var content = sr.ReadToEnd();  
                    Console.WriteLine("Url: " + url + " \n" + "Content length: " + content.Length + "\n" + "Response: \n" + content);
                }
            }
            catch (Exception e)  
            {
                Console.WriteLine("Url " + url + " is failed. \n" + e.Message);
            }
            Console.ReadKey();
        }
    }
}

```

--------------------------------

### Python Proxy Setup with Requests Library

Source: https://helpcenter.soax.com/en/articles/4830123-proxy-set-up-using-curl-php-net-with-c-or-python

Illustrates how to configure and utilize HTTP and HTTPS proxies in Python using the Requests library. It shows the dictionary format for proxy settings and making a GET request to a checker API.

```python
import requests as req  
  
proxy = {  
    "http": "http://0YFEkZzfrwBX4Wfp:wifi;pl;@proxy.soax.com:9000",  
    "https": "http://0YFEkZzfrwBX4Wfp:wifi;pl;@proxy.soax.com:9000"  
}
  
resp = req.get("http://checker.soax.com/api/ipinfo",proxies=proxy)  
  
print(resp.text)
```

--------------------------------

### Puppeteer Proxy Configuration Script (JavaScript)

Source: https://helpcenter.soax.com/en/articles/6263148-puppeteer

This JavaScript code snippet demonstrates how to launch Puppeteer with a specified proxy server. It includes launching the browser, navigating to a URL, taking a screenshot, and closing the browser. Ensure Puppeteer is installed (`npm install puppeteer`).

```javascript
const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch({
    headless: false,
    args: ['--proxy-server=proxy.soax.com:10001']
  });
  const page = await browser.newPage();
  await page.authenticate();
  await page.goto('https://soax.com/');
  await page.screenshot({path: 'example.png'});
  await browser.close();
})();
```

--------------------------------

### Selenium Chrome Proxy Setup with Extension (Python)

Source: https://helpcenter.soax.com/en/articles/6349300-selenium

Python code to configure Selenium WebDriver for Chrome using a previously created proxy extension. It initializes Chrome options, adds the proxy extension, and starts a Chrome instance directed to a specified URL.

```python
from selenium import webdriver   
from selenium.webdriver.chrome.options import Options   
chrome_options = Options()   
chrome_options.add_extension("proxy.zip")   
driver = webdriver.Chrome(executable_path='chromedriver.exe', chrome_options=chrome_options)   
driver.get("http://google.com")   
driver.close()
```

--------------------------------

### Test SOAX Proxy with CURL (Linux, macOS, Windows)

Source: https://helpcenter.soax.com/en/articles/4830123-proxy-set-up-using-curl-php-net-with-c-or-python

This snippet shows how to test SOAX proxy connectivity using the CURL command-line tool. It provides examples for Linux, macOS, and Windows, including instructions for enabling CURL on Windows. The output confirms successful proxy connection and IP information.

```bash
$ curl -x "http://0YFEkZzfrwBX4Wfp:wifi;pl;@proxy.soax.com:9000" -L http://checker.soax.com/api/ipinfo
```

```bash
curl -x "http://0YFEkZzfrwBX4Wfp:wifi;pl;@proxy.soax.com:9000" -L http://checker.soax.com/api/ipinfo
```

```bash
curl -x http://0YFEkZzfrwBX4Wfp:wifi;pl;@proxy.soax.com:9000 -L http://checker.soax.com/api/ipinfo
```

```bash
curl -x http://0YFEkZzfrwBX4Wfp:wifi;pl;@proxy.soax.com:9000 -L https://checker.soax.com/api/ipinfo
```

--------------------------------

### SOAX Request String Examples

Source: https://helpcenter.soax.com/en/articles/6723733-sticky-sessions

A collection of examples demonstrating various SOAX proxy request string formats. These examples cover random proxy selection, specific country targeting, sticky sessions with different session lengths, and combinations of location parameters.

```text
proxy.soax.com:5000 package-{your_package_id}:{your_package_login}
proxy.soax.com:5000 package-{your_package_id}-country-{cc_code}:{your_package_login}
proxy.soax.com:5000 package-{your_package_id}-country-{cc_code}-sessionid-{session_id}:{your_package_login}
proxy.soax.com:5000 package-{your_package_id}-country-{cc_code}-city-{city_name}-sessionid-{session_id}:{your_package_login}
proxy.soax.com:5000 package-{your_package_id}-country-{cc_code}-city-{city_name}-sessionid-{session_id}-sessionlength-{time_in_sec}:{your_package_login}
proxy.soax.com:5000 package-{your_package_id}-country-{cc_code}-region-{region_name}-city-{city_name}-isp-{isp_carrier}-sessionid-{session_id}-sessionlength-{time_in_sec}:{your_package_login}
```

--------------------------------

### Test SOAX Proxy with PHP

Source: https://helpcenter.soax.com/en/articles/4830123-proxy-set-up-using-curl-php-net-with-c-or-python

This PHP script demonstrates how to connect to SOAX proxies using the `file_get_contents` function and stream contexts. It utilizes basic authentication for proxy access and retrieves IP information from the checker API. The example is tested on Ubuntu with PHP 5.6.

```php
<?php  
$auth = base64_encode('0YFEkZzfrwBX4Wfp:wifi;pl;');  
$aContext = array(
    'http' => array(
        'proxy'           => 'tcp://proxy.soax.com:9000',
        'request_fulluri' => true,
        'header'          => "Proxy-Authorization: Basic $auth",
    ),
);
$cxContext = stream_context_create($aContext);
$sFile = file_get_contents("http://checker.soax.com/api/ipinfo", False, $cxContext);
echo $sFile, "\n";
?>
```

--------------------------------

### Get Node Info with "respond-with" Header using cURL

Source: https://helpcenter.soax.com/en/articles/9956908-getting-node-information-with-the-respond-with-header

This example demonstrates how to use the cURL command-line tool to send a request with the "respond-with" header. It specifies the desired information (IP and country) and the target URL. This method is useful for quick testing and understanding the header's functionality.

```bash
curl -x "<your package login>:wifi;gb@proxy.soax.com:9000" --proxy-header "respond-with: ip,country" -v https://www.cloudflare.com/cdn-cgi/trace
```

--------------------------------

### Proxy Connection Example

Source: https://helpcenter.soax.com/en/articles/9939557-understanding-session-parameters

Example cURL command demonstrating how to use session parameters within a proxy URL to connect to a service and retrieve IP information.

```APIDOC
## Proxy Connection Example

### Description
An example cURL command showing how to configure session parameters (`sessionlength`, `bindttl`, `idlettl`) within the proxy URL to establish a connection and access an API endpoint.

### Method
GET

### Endpoint
`http://checker.soax.com/api/ipinfo` (accessed via proxy)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
- **sessionlength** (integer) - 3600 - Session duration in seconds.
- **bindttl** (integer) - 1200 - Binding time to live in seconds.
- **idlettl** (integer) - 900 - Idle time to live in seconds.
- **country** (string) - ca - Desired country code.
- **isp** (string) - sasktel - Desired ISP.

#### Request Body
N/A

### Request Example
```bash
curl -k -x "http://package-11111-sessionid-1-sessionlength-3600-bindttl-1200-idlettl-900-country-ca-isp-sasktel:kflrofJKFOfkklo8986@proxy.soax.com:5000" -L http://checker.soax.com/api/ipinfo
```

### Response
#### Success Response (200)
Returns IP information from the `checker.soax.com` service.

#### Response Example
```json
{
  "ip": "1.2.3.4",
  "country": "Canada",
  "isp": "SaskTel"
}
```
```

--------------------------------

### Basic Sticky Session Example for US (MacOS)

Source: https://helpcenter.soax.com/en/articles/6723733-sticky-sessions

This example shows how to configure a SOAX proxy with sticky sessions for the US on MacOS, with a session length of 180 seconds. It uses `curl` and requires proper quoting for the proxy URL.

```bash
curl -k -x "package-<your_package_id>-country-us-sessionid-1-sessionlength-180:<your_package_login>@proxy.soax.com:5000" -L http://checker.soax.com/api/ipinfo
```

--------------------------------

### Configure Python Requests with SOAX Proxies

Source: https://helpcenter.soax.com/en/articles/10125344-proxy-set-up-using-curl-php-net-with-c-or-python-dashboard-v2

This Python code snippet shows how to use the Requests library to make an HTTP GET request through SOAX proxies. It defines a dictionary for proxy settings (HTTP and HTTPS) and then sends the request to a checker API. This example is compatible with Python 2.7 and 3.6.

```python
import requests as req

proxy = {
    "http": "http://package-256478-country-us-sessionid-number01-sessionlength-300:6yO9bR2syuwlhvtb@proxy.soax.com:5000",
    "https": "http://package-256478-country-us-sessionid-number01-sessionlength-300:6yO9bR2syuwlhvtb@proxy.soax.com:5000"
}

resp = req.get("https://checker.soax.com/api/ipinfo",proxies=proxy)

print(resp.text)
```

--------------------------------

### Send First Request with SOAX Web Data API (curl)

Source: https://helpcenter.soax.com/en/articles/11297318-getting-started-with-soax-web-data-api

This example demonstrates how to send a POST request to the SOAX Web Data API using curl to fetch the HTML content of a specified URL. It includes settings for proxy country and desired response body. Ensure you replace 'your API key' with your actual SOAX API secret.

```bash
curl -X POST "https://scraping.soax.com/v2/webdata/fetch-content" -H "X-SOAX-API-Secret: your API key" -H "Content-Type: application/json" --data-raw '{ "url": "https://www.example.com", "proxy_settings": { "country": "us", "type": 1 }, "response": { "body": true, "screenshot": false, "xhr": false, "markdown": false } }'
```

--------------------------------

### Fetch Content API

Source: https://helpcenter.soax.com/en/articles/11297318-getting-started-with-soax-web-data-api

This endpoint allows you to fetch the content of a given URL. You can specify various options for proxy settings, response format, and rendering.

```APIDOC
## POST /v2/webdata/fetch-content

### Description
Fetches the rendered content of a specified URL, handling proxies, CAPTCHAs, and JavaScript rendering.

### Method
POST

### Endpoint
https://scraping.soax.com/v2/webdata/fetch-content

### Parameters
#### Header Parameters
- **X-SOAX-API-Secret** (string) - Required - Your API key for authentication.
- **Content-Type** (string) - Required - Must be set to `application/json`.

#### Request Body
- **url** (string) - Required - The URL of the website to scrape.
- **proxy_settings** (object) - Optional - Settings for proxy usage.
  - **country** (string) - Optional - The country code for the proxy (e.g., "us").
  - **type** (integer) - Optional - The type of proxy (e.g., 1 for residential).
- **response** (object) - Optional - Specifies the desired output formats.
  - **body** (boolean) - Optional - Whether to include the HTML body in the response (defaults to true).
  - **screenshot** (boolean) - Optional - Whether to include a screenshot (defaults to false).
  - **xhr** (boolean) - Optional - Whether to include XHR logs (defaults to false).
  - **markdown** (boolean) - Optional - Whether to include Markdown formatted content (defaults to false).

### Request Example
```json
{
  "url": "https://www.example.com",
  "proxy_settings": {
    "country": "us",
    "type": 1
  },
  "response": {
    "body": true,
    "screenshot": false,
    "xhr": false,
    "markdown": false
  }
}
```

### Response
#### Success Response (200)
- **html** (string) - The rendered HTML content of the page (if `response.body` is true).
- **screenshot** (string) - A base64 encoded PNG image of the page (if `response.screenshot` is true).
- **xhr** (array) - An array of background API responses (if `response.xhr` is true).
- **markdown** (string) - The content in Markdown format (if `response.markdown` is true).

#### Response Example
```json
{
  "html": "<!DOCTYPE html>\n<html>\n<head>\n    <title>Example Domain</title>\n</head>\n<body>\n\n<h1>Example Domain</h1>\n<p>This domain is for use in illustrative examples in documents. You may use this\ncontent freely in both private and commercial applications. See the The\nRe-use Policy for full details.</p>\n<p><a href=\"https://www.iana.org/domains/example\">More information...</a></p>\n</body>\n</html>"
}
```
```

--------------------------------

### Get Node Info with "respond-with" Header in Node.js

Source: https://helpcenter.soax.com/en/articles/9956908-getting-node-information-with-the-respond-with-header

This Node.js example utilizes the 'https' module to make a request with the "respond-with" header. It configures the proxy settings and the custom header to fetch specific node details. This is suitable for backend applications built with Node.js.

```javascript
const https = require('https');

const proxyHost = 'proxy.soax.com';
const proxyPort = 9000;
const proxyLogin = '<your package login>';
const proxyPassword = 'wifi';

const options = {
  hostname: 'www.cloudflare.com',
  port: 443,
  path: '/cdn-cgi/trace',
  method: 'GET',
  headers: {
    'Proxy-Authorization': `Basic ${Buffer.from(`${proxyLogin}:${proxyPassword}`).toString('base64')}`,
    'Proxy-Connection': 'keep-alive',
    'respond-with': 'ip,country'
  },
  agent: new https.Agent({
    proxy: {
      host: proxyHost,
      port: proxyPort
    }
  })
};

const req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  let data = '';
  res.on('data', (chunk) => {
    data += chunk;
  });

  res.on('end', () => {
    console.log(data);
  });
}).on('error', (e) => {
  console.error(e);
});

req.end();

```

--------------------------------

### SOAX Multiple Sticky Session Configuration Example

Source: https://helpcenter.soax.com/en/articles/6723733-sticky-sessions

This example shows how to configure multiple SOAX proxy sessions with different countries, session IDs, and session lengths. It demonstrates flexibility in setting up distinct proxy environments for various needs.

```text
proxy.soax.com:5000 package-64412-country-us-sessionid-rand123456-sessionlength-90:PFh4Nm42Boe6hcJ0
proxy.soax.com:5000 package-64412-country-uk-sessionid-tsa122-sessionlength-180:PFh4Nm42Boe6hcJ0
proxy.soax.com:5000 package-64412-country-br-sessionid-rwaf123122-sessionlength-360:PFh4Nm42Boe6hcJ0
```

--------------------------------

### Using HTTPS Proxy with cURL

Source: https://helpcenter.soax.com/en/articles/7241369-http-vs-socks5-vs-https-which-proxy-protocol-should-you-use

This example demonstrates how to use an HTTPS proxy with the cURL command-line tool. It shows the syntax for specifying the proxy server, including authentication credentials and port. The `-k` flag is used to ignore certificate validation, and `-v` provides verbose output for debugging.

```bash
curl -k -x "https://package-000000-country-us:<package_key>@proxy.soax.com:5000" -L https://checker.soax.com/api/ipinfo -v
```

--------------------------------

### Chrome Extension Manifest (JSON)

Source: https://helpcenter.soax.com/en/articles/6349300-selenium

The manifest file for the Chrome proxy extension. It declares the extension's version, name, required permissions (like Proxy, webRequest), and specifies the background service worker script.

```json
{
"version": "1.0.0",
"manifest_version": 3,
"name": "Chrome Proxy",
"permissions": [
"Proxy",
"Tabs",
"unlimitedStorage",
"Storage",
"<all_urls>",
"webRequest",
"webRequestBlocking"
],
"background": {
"service_worker": "background.js"
},
"Minimum_chrome_version":"76.0.0"
}
```

--------------------------------

### Basic Sticky Session Example for US (Windows)

Source: https://helpcenter.soax.com/en/articles/6723733-sticky-sessions

This example demonstrates how to use a SOAX proxy with sticky sessions for the US, setting a session length of 180 seconds. It utilizes the `curl` command, a common tool for making HTTP requests.

```bash
curl -k -x http://package-<your_package_id>-country-us-sessionid-1-sessionlength-180:<your_package_login>@proxy.soax.com:5000 -L http://checker.soax.com/api/ipinfo
```

--------------------------------

### Chrome Extension for Proxy Authentication (JavaScript)

Source: https://helpcenter.soax.com/en/articles/6349300-selenium

This JavaScript code creates a Chrome extension to handle proxy authentication. It configures the proxy server and intercepts authentication requests to provide credentials. This is used in conjunction with Selenium's add_extension method.

```javascript
var config = {   
mode: "fixed_servers",   
rules: {   
singleProxy: {   
scheme: "http",   
host: "proxy.soax.com",   
port: parseInt(9000)   
},   
bypassList: ["soax.com"]   
}
};
chrome.proxy.settings.set({value: config, scope: "regular"}, function() {});  
function callbackFn(details) {   
return {   
authCredentials: {   
username: "PROXY_USERNAME",   
password: "PROXY_PASSWORD"   
}
};
}
  
chrome.webRequest.onAuthRequired.addListener(   
callbackFn,   
{urls: ["<all_urls>"]},   
['blocking']   
);
```

--------------------------------

### Dynamic Proxy Port Configuration (Python)

Source: https://helpcenter.soax.com/en/articles/6349300-selenium

Python script for configuring Selenium WebDriver with a dynamic proxy port. It uses the 'random' module to select a port within a specified range and sets up the proxy details for HTTP, SSL, and SOCKS connections.

```python
from selenium import webdriver 
from selenium.webdriver.common.proxy import Proxy, ProxyType 
from selenium.webdriver.support.ui import WebDriverWait 
from selenium.webdriver.support import expected_conditions as EC 
import random 

# Proxy credentials 
proxy_username = "YOUR PACKAGE LOGIN" 
proxy_password = "wifi;us;;;"

# Proxy server address 
proxy_server = "proxy.soax.com"

# Generate a random proxy port number between 9000 and 9999 
new_proxy_port = random.randint(9000, 9999)

# Configure proxy with the new port 
proxy = Proxy()
proxy.proxy_type = ProxyType.MANUAL
proxy.http_proxy = f"{proxy_server}:{new_proxy_port}"
proxy.ssl_proxy = f"{proxy_server}:{new_proxy_port}"
proxy.socks_proxy = f"{proxy_server}:{new_proxy_port}"
proxy.ssl_proxy = f"{proxy_server}:{new_proxy_port}"
proxy.ftp_proxy = f"{proxy_server}:{new_proxy_port}"
proxy.no_proxy = "" 

# Authentication credentials 
auth_username = proxy_username 
auth_password = proxy_password
```
Tokens:
Raw