Web Scraping API Documentation
Read our getting started guide here →
The API endpoint is
You can send a
Note that you should replace
YOUR_API_TOKEN with your API token.
token field to the request to authenticate yourself.
Alternatively you can set your token in the
Each API requests uses our proxy network by default. Geotargetting is not possible with our normal proxy network.
5. Residential Proxies
We also offer residential proxies. A residential proxy allows the API to connect to a real internet connection. With this you can counter almost all IP bot detection systems.
To enable residential proxies set the
residential_proxy field to
You can also set the
proxy_location parameter when using residential proxies.
Currently we support the following values for
proxy_location will only work with
6. Additional Parameters
6.1 Custom Headers
All headers send to our API with a
SB- prefix will be forwarded to the target website.
You will have to add the
SB- prefix so that the API recognizes what headers to forward.
The API will remove the prefix before forwarding the header.
For example, if you only speak klingon, you can set the
SB-Accept-Langauge header to
klingon like this.
7. Response Headers
With each request the following response headers are sent.
|The cost of the request.
|Your remaining credits this period.
|The final URL of the scraped webpage. This is useful for detecting redirects.
If the API encounters a
5xx status on the website it will fail along with a JSON error message.
These failed requests will not cost any credits
For example, if the API encounters a
403 response code it will return the following.
"response": `The website returned a 403 status code.
You can try again with:
3) check out our troubleshooting guide: