Getting Started

Introduction

Webscraping API is a simple and effective REST API interface for scraping web pages at scale.

The API automatically takes care of tasks that would to be dealt with programatically such as:

  • Gelocations
  • IP Blocks
  • IP Rotations
  • Captchas
  • JavaScript Rendering
  • Residential Proxies
  • Data Center Proxies
  • Custom HTTP Headers
  • Custom Cookies

In this documentation you will find detailed usage guides and code examples in different programming languages that will help you get up and running in the shortest time possible. If the articles below leave any questions unanswered, please feel free to contact our technical support team.

Getting Started

To authorize your API call, append the api_key parameter to the url:

https://api.webscrapingapi.com/v1?api_key=YOUR API KEY

After creating a WebscrapingAPI account, the account dashboard will reveal the unique API access key you can use to authenticate with the API. To do so, simply attach the api_key parameter to the API’s base URL and set it to your API access key.

Example:

https://api.webscrapingapi.com/v1?api_key=YOUR API KEY&url=https%3A%2F%2Fhttpbin.org%2Fget
Secure your key: To prevent unauthorized access to your WebscrapingAPI account, please make sure to store your API access key in a secure location and never include it in any public scripts or files.

In the following code examples, we use a dummy API key of XXXXXX. Please replace it with your real API key.

API Error Codes

If your request fails, WebscrapingAPI will return an error in JSON format. Find to the right an example error that occurs when the API failed scraping the requested URL.