Skip to main content
Webscraper io logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: WEBSCRAPER_IO
  • Version: 20261101_00

Tools

Slug: WEBSCRAPER_IO_CREATE_SITEMAPTool to create a new sitemap configuration for web scraping. Use when you need to define a new scraping structure with start URLs and selector rules for data extraction from a website.

Input Parameters

array
required
Array of starting URLs where scraping begins. At least one URL is required.
array
required
Array of selector objects defining data extraction rules. Minimum one selector required.
string
required
Unique identifier for the sitemap. Must be alphanumeric with hyphens (e.g., ‘webscraper-io-landing’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_DELETE_SITEMAPTool to permanently delete a sitemap configuration from Web Scraper Cloud account. Use when you need to remove a sitemap that is no longer needed.

Input Parameters

integer
required
The unique identifier of the sitemap to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_DISABLE_SITEMAP_SCHEDULERTool to disable automatic scheduling for a sitemap. Use when you need to stop automated scraping jobs from running on a schedule.

Input Parameters

integer
required
The unique identifier of the sitemap whose scheduler should be disabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_ENABLE_SITEMAP_SCHEDULERTool to enable and configure automatic scheduling for sitemap scraping jobs. Use when you need to automate scraping jobs to run at specific times using cron expressions with customizable request intervals, page load delays, driver types, and proxy settings.

Input Parameters

string
Proxy configuration. Use format ‘datacenter-{country_code}’ (e.g., ‘datacenter-us’) or ‘residential-{country_code}’ (e.g., ‘residential-us’), or 0 for no proxy, or 1 to use proxy, or proxy id for Scale plan users
string ("fast" | "fulljs")
required
Scraper driver type. ‘fast’ doesn’t execute JavaScript and extracts from raw HTML. ‘fulljs’ is full driver with JavaScript execution
string
required
Day of month field of cron expression. Use ’*’ for any day, ‘1-31’ for range, or specific values
string
required
Hour field of cron expression. Use ’*’ for any hour, ‘0-23’ for range, or specific values like ‘9,17’
string
required
Month field of cron expression. Use ’*’ for any month, ‘1-12’ for range, or specific values
integer
required
The unique identifier of the sitemap to enable scheduling for
string
required
Minute field of cron expression. Use '' for any minute, ‘/10’ for every 10 minutes, or specific values like ‘0,15,30,45’
string
required
Day of week field of cron expression. Use ’*’ for any weekday, ‘0-6’ for range (0=Sunday), or specific values
string
required
Timezone for cron schedule using tz database format (e.g., ‘Europe/Riga’, ‘America/New_York’, ‘Asia/Tokyo’)
integer
required
Time period in milliseconds that scraper will wait for the page to load before extracting data. Default is 2000ms (2 seconds)
integer
required
Page request interval in milliseconds. Default is 2000ms (2 seconds). Defines the delay between page requests during scraping

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_GET_ACCOUNT_INFOTool to retrieve account information including email and page credits. Use when you need to check account details or available credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_GET_SCRAPING_JOBSTool to retrieve all scraping jobs for the account with optional filtering and pagination. Use when you need to list scraping jobs, check job status, or filter jobs by sitemap or tag.

Input Parameters

string
Filter jobs by tag name. Use to retrieve jobs with a specific tag.
integer
Page number for pagination. Use to retrieve specific page of results.
integer
Filter jobs by specific sitemap ID. Use to retrieve jobs for a particular sitemap.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_GET_SITEMAPTool to retrieve a specific sitemap configuration by ID. Use when you need to inspect or reference an existing sitemap’s configuration.

Input Parameters

integer
required
The numeric identifier of the sitemap to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_GET_SITEMAPSTool to retrieve all sitemaps for the authenticated account with pagination support. Use when you need to list available sitemaps or filter them by tag. Supports optional pagination via page parameter and filtering by tag name.

Input Parameters

string
Filter sitemaps by tag name to retrieve only sitemaps with a specific tag.
integer
Page number for pagination (e.g., 2 for the second page).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_GET_SITEMAP_SCHEDULERTool to retrieve scheduler configuration for a sitemap. Use when you need to check scheduling settings including cron configuration and proxy settings.

Input Parameters

integer
required
The unique identifier of the sitemap

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WEBSCRAPER_IO_UPDATE_SITEMAPUpdate an existing sitemap configuration by ID, supplying its internal identifier, start URLs, and selectors.

Input Parameters

string
required
Internal identifier for the sitemap
array
required
Array of selector objects defining data extraction rules
array
required
Array of URLs where scraping begins
integer
required
The unique identifier of the sitemap to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not