Skip to main content
POST
/
v1
/
webUnlocker
Scrape page
curl --request POST \
  --url https://api.example.com/v1/webUnlocker \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "url": "https://ip-api.com",
  "country": "US",
  "city": "New York",
  "difficulty": "low",
  "expiration": 0
}
'
{
  "html": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
url
string<uri>
required

Target page URL

Example:

"https://ip-api.com"

​
country
string

2-letter country code from where request would be made

Example:

"US"

​
city
string

City from where request would be made. Must be a valid city name from https://www.geonames.org/

Example:

"New York"

​
difficulty
enum<string>

Access difficulty pool, values low or medium. Default is low

Available options:
low,
medium
Example:

"low"

​
expiration
number

Maximum age of cached content in days, 0 will invalidate cache on every request

Example:

0

Response

200 - application/json

Successful response

​
html
string
required

HTML content of the target page