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 -kx browser.webit.live:8888 \ 
-U "<nimble API user>:<password>" https://mytargetsite.com/ \
-H "x-nimble-country: US" \
-H "Header: custom header value" \
-H "x-nimble-render: true" \
-H "x-nimble-parse: true"

Request parameters

Parameter	Required	Description
x-nimble-country	optional	String: Two-letter country code, e.g. US, DE, BR.
Custom-Header	optional	String: Add custom headers to the request.
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.

Unlocker Proxy should not be used with headless browsers or their drivers (Puppeteer, Selenium, etc.) All rendering is handled on the server side.

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