General Params
Params marked in red are currently for internal use only, and not part of our public documentation.
url
Required
URL | The page or resource to be fetched. Note: when using a URL with a query string, encode the URL and place it at the end of the query string.
method
Optional (default = GET)
String | The method for requesting a URL from the target server.
parse
Optional (default = false)
Boolean: true | false - True - the page's content will be parsed and returned in a JSON format. False - Response will include page headers and raw data (without parsing).
render
Optional (default = false)
Boolean: true | false - enables or disables Javascript rendering on the target page
driver
Optional (default = vx6)
Enum: vx6 | vx8 | vx8-pro | vx10 | vx10-pro- Manually select the browserless driver
format
Optional (default = JSON)
Enum: JSON | HTML | JSON-LINES | RAW - The data response format. HTML - in case of error, returns JSON with error message.
country
Optional (default = all)
String | Country used to access the target URL, use ISO Alpha-2 Country Codes i.e. US, DE, GB
state
Optional (default = null)
String | State used to access the target URL, use ISO Alpha-2 Country Codes i.e. NY, AZ, CA
city
Optional (default = null)
String | City used to access the target URL i.e. paris, london
locale
Optional (default = auto)
String | LCID standard locale used for the URL request. Alternatively, user can use auto for automatic locale based on geo-location.
is_xhr
Optional (default = false)
Boolean | Instructs the Web API that the target page is an XHR request instead of a standard webpage. Only available when render is set to false (default)
no_html
Optiona (default = false)
Bool | If set to true, the API will exclude HTML content from the response.
consent_header
Optional (default = false)
Bool | if set to true, nimble will add a scraping consent header letting the target domain know they are being scraped by Nimble
user_context
Optional (default = null)
String | 256 characters long, representing a context text provided by the user, mainly used for async/batch requests.
expected_status_codes
Optional (default = [200])
List of integers | Defines valid HTTP status codes for the request. Responses matching any listed code are treated as successful requests.
Last updated