Overview

Here is a list of different parameters you can use with ScrapeAutomate. This overview will help you get started with ScrapeAutomate while ensuring secure usage of your credentials.

Query Parameters

Parameter	Type	Description	Required	Default
api_key	string	Your unique API key to authenticate every request.	true	Get your API key
url	string	The URL of the web page you want to scrape.	true
render	boolean	Whether to render JavaScript while scraping.	false	false
window_width	number	The width of the browser window.	false	1920
window_height	number	The height of the browser window.	false	1080
markdown	boolean	Returns the scraped data in markdown.	false	false
screenshot	boolean	Returns screenshot of the web page.	false	false
webhook_url	string	Used for setting a webhook where the response will be sent to.	false
instructions	object[]	This Allows you to interact with the web page.	false
proxy_type	string	The type of proxy to use while scraping for better anonymity, performance and speed	false
proxy_country	string	The location of the proxy server.	false
workflow_id	string	Reuse configurations from a saved workflow.	false
block_resources	boolean	Blocks specific web resources (stylesheets, images, media, etc.) during automation using block_resources. Separate multiple resources with ”,” . Useful for faster scraping and preventing unnecessary loading.	false	false
block_ads	boolean	Whether to block ads while scraping.	false	false
block_chat_widgets	boolean	Automatically block chat widgets from appearing in the ui.scraping.	false	false
block_cookie_banners	boolean	Automatically block cookie banners from appearing in the ui.scraping.	false	false

Getting Started

ScrapeAutomate is one of the easiest scraping tools available on the web.

To get started with scraping, you only need two things:

• Your unique api_key
• The Encoded URL of the web page you want to scrape.

You can get your API key after creating an account on ScrapeAutomate.

API Key

Your unique API key is essential to authenticate every API request. After creating and verifying your account on ScrapeAutomate, your API key will be visible on the builder page as highlighted in the image below.

Code Example

cURL

curl --request GET \
    --url 'https://app.scrapeautomate.com/api/scraper?api_key=<exampleToken>'

Do not share your API key with anyone. Sharing your API key can lead to unauthorized access, unexpected charges, and potential security vulnerabilities.

URL

You must provide an encoded-URL to use ScrapeAutomate API. Encoding ensures that the URL is processed correctly by the API and that special characters (like spaces, question marks, and ampersands) do not cause issues.

You can use websites like urlencoder to easily encode your URLs.

After encoding the URL, pass it in the query parameter named url as shown below:

cURL

curl --request GET \
    --url 'https://app.scrapeautomate.com/api/scraper?api_key=<exampleToken>&url=https%3A%2F%2Fexample.com'

The url parameter and api_key are both required. If any of these parameters are missing, your request won’t be processed.

Render

The render parameter is a boolean value that determines whether ScrapeAutomate should render javascript while scraping. Setting render to true enables features like taking screenshots, blocking specific resources, form-filling, and clicking elements.

cURL

curl --request GET \
    --url 'https://app.scrapeautomate.com/api/scraper?api_key=<exampleToken>&render=true&url=https%3A%2F%2Fexample.com'

By default, the render parameter is set to false. Note that launching a browser consumes more ten times more credits.