WebScrapingAPI Docs
HomeLoginRegister
  • Introduction
    • Registration
    • Pricing
    • Free APIs
    • API Errors
    • Custom Response Headers
  • Browser API
    • Getting Started
      • Access the API
      • Authentication
      • API Parameters
    • Basic API Requests
      • GET Request
      • POST, PUT & PATCH Requests
      • Proxy Mode
    • Advanced API Features
      • Awaiting
      • Geolocation
      • Sessions
      • Forcing Timeouts
      • Custom Headers
      • Custom Cookies
      • Device Type
      • Viewport Sizing
      • Screenshot
      • Screenshot Options
      • Extraction Rules
      • JavaScript Instructions
      • Full JSON Response
      • JSON DOM Response
      • Block Resources
      • Captcha Solving
  • WebScrapingAPI
    • Getting Started
      • Access the API
      • API Parameters
    • Basic API Requests
      • GET Request
      • POST, PUT & PATCH Requests
    • Advanced API Features
      • Geolocation
      • Extraction Rules
      • Full JSON Response
      • JSON DOM Response
      • Rendering JavaScript
  • WebStealthProxy
    • Getting Started
      • Access the Proxy
      • Usage and Statistics
    • Basic Proxy Requests
    • Advanced Proxy Requests
      • Sessions
      • Geolocation
      • Custom Headers
      • Custom Cookies
      • Screenshots
  • Google Search API
    • Getting Started
      • Access the API
      • API Parameters
    • Google Search Engines
      • Google Search API
      • Google Maps API
      • Google Maps Reviews API
      • Google Reverse Image API
      • Google Trends API
        • Geo Parameter Options List
        • Google Trends Categories List
  • WB CUSTOM SEARCH API
    • Getting Started
      • Access the API
      • API Parameters
    • WB Custom Search Engines
      • Wayfair Product API
      • Best Buy Product API
      • Nordstrom Product API
  • Amazon Search API
    • Getting Started
      • API Parameters
      • Access the API
      • Supported Domains
    • Amazon Search Types
      • Amazon Search
      • Amazon Seller
        • Amazon Seller Products
        • Amazon Seller Profile
        • Amazon Seller Feedback
      • Amazon Product
      • Amazon Category
      • Amazon Bestsellers
      • Amazon New Releases
      • Amazon Deals
  • Bing Search API
    • Getting Started
      • Access the API
      • API Parameters
    • Basic API Requests
Powered by GitBook
On this page
  • #1: Required Parameters
  • #2: Optional Parameters
  1. WebScrapingAPI
  2. Getting Started

API Parameters

Discover the full power of WebScrapingAPI by passing advanced parameters to your requests.

PreviousAccess the APINextBasic API Requests

Last updated 8 months ago

Parameters are being used to customise each request to the API. Understanding how to use these parameters will allow you to reach the full potential of the WebScrapingAPI and better interact with the targeted URL.

Below is a list of all the parameters available in our API:

#1: Required Parameters

Parameter
Type
Description
More

api_key Required

string

Used for authentication

url Required

string

Specify the URL of the web page you would like to scrape.

IMPORTANT: Please make sure you URL encode the value of this parameter!

#2: Optional Parameters

Parameter
Type
Description
More

render_js

boolean

Set to 0 (off, default) or 1 (on) depending on whether or not to render JavaScript on the target web page. JavaScript rendering is done by using a browser.

country

string

Specify the 2-letter code of the country you would like to use as a proxy geolocation for your scraping API request.

city

string

Specify the city you would like the request to originate from. The country is required in this case.

asn

string

Set the ASN (Autonomous System Number) of the network you want your proxy to be from.

timeout

int

Specify the maximum timeout in milliseconds you would like to use for your scraping API request. In order to force a timeout, you can specify a number such as 1000.

This will abort the request after 1000ms. The maximum value for this parameter is 120000. The default value for this parameter is also 120000.

extract_rules

object

Get the scraped website based on various extraction rules.

json_response

boolean

Have the API return a JSON object instead of the plain HTML scraped from the URL.

json_dom

boolean

Get the scraped website in JSON format. It can be set to 0 (default) or 1.

For boolean parameters, you can provide values in multiple formats. If the parameter is set to '0' or 'false', it will be treated as false, meaning the feature will be disabled or set to off. If you send '1' or 'true', the parameter will be interpreted as true, enabling or turning on the feature. The system recognizes both numeric and string representations of boolean values for flexibility in different use cases.

learn
learn
learn
learn
learn
learn
learn
learn
learn