Unlocker Proxy

Unlocker Proxy was designed to solve the problem of anti-bot systems for web scraping users seamlessly. It combines our Nimble IP residential proxies with advanced, AI-powered unlocking technology in the form of Nimble Browser.

Users turn to Unlocker Proxy to enjoy a variety of upgrades including:

How it works

To make Unlocker Proxy as simple as possible to integrate, we've designed a standard, proxy-style connection API that makes it seamless to move from residential proxies to Unlocker Proxy.

Behind the scenes, Unlocker Proxy automates the key technologies needed to execute the request and bypass anti-bots, including:

Real Time Request

Unlocker Proxy provides a simplified, one-line approach to data collection that is easy to use and implement across a variety of programming languages and environments. Unlocker Proxy accepts fully-formed URLs, and provides access to many of the key features of the Nimble Browser such as page rendering and data parsing.

Example request

curl -k \
  --proxy 'http://unlocker.webit.live:8888' \
  --proxy-user 'USERNAME:PASSWORD' \
  -H "Header: custom header value" \
  -H 'x-nimble-country: US' \
  -H 'x-nimble-parse: true' \
  -H 'x-nimble-render: false' \
  -H 'x-nimble-format: json' \
  -H 'x-nimble-locale: en-US' \
  -H 'x-nimble-no-html: true' \
  -H 'x-nimble-session-id: my-session-123' \
  'https://www.ipinfo.com'

Request parameters

Parameter
Required
Description

x-nimble-country

optional

String: Two-letter country code, e.g. US, DE, BR.

x-nimble-render

optional

Boolean: true | false | auto - Whether or not the target resource’s Javascript should be rendered. This is sometimes required in order to properly load some websites.

x-nimble-parse

optional

Enum: true | false - Whether or not the Nimble Browser should parse the requested web data into a JSON structure, or return only the raw HTML. The full raw HTML is returned in both cases.

x-nimble-format

optional

Enum: JSON | HTML | JSON-LINES | RAW - The data response format. HTML - in case of error, returns JSON with error message.

x-nimble-locale

optional

String | LCID standard locale used for the URL request. Alternatively, user can use auto for automatic locale based on geo-location.

x-nimble-no-html

optional

Bool | If set to true, the API will exclude HTML content from the response.

x-nimble-session-id

optional

String | Sticky session ID for multiple related requests.

Custom-Header

optional

String: Add custom headers to the request.

Response

If the request was executed successfully, the Unlocker Proxy will return a 200 OK message with the following data:

{	
        "status": "success",
        "html_content": string,
        "parsing": {
             "status" : "success",
             "entities": { },
             "total_entities_count": 0,
             "entities_count": { }
    }
}

The html_content node contains the full HTML of the requested page, and if parsing was enabled, the parsing node will contain a structured JSON object of the data.

Response codes

Status
Description

200

OK

400

The requested resource could not be reached

401

Unauthorized/Invalid Token

500

Internal service error

501

An error was encountered by the proxy service

555

Request timeout

Last updated