Skip to main content
POST

Request Parameters

Body

string
URL of the page to scrape. Either url or html is required, but not both.
string
HTML content to scrape. Either url or html is required, but not both.
array<string> | object
Items on the page to scrape (maximum 5). Can be an array of strings (e.g. ["Plan price", "Plan title"]) or an object with key-value pairs (e.g. {"price": "Plan price", "title": "Plan title"}).
boolean
default:"false"
When enabled, automatically scrolls through the entire page to return full-page results.
array<string>
CSS elements on the page to scrape. E.g. “h2.title”, “div.price”
string
default:"main"
CSS selector to limit the scope of scraping to a specific element and its children
number
default:"1"
For pagination, the current page number (minimum: 1)
array<string>
default:["meta","link"]
Features to extract from the page. Available options:
  • meta - Extract page metadata (title, description, keywords, og_image)
  • link - Extract links detected on the page
object
Advanced configurations
object
Custom HTTP headers to send with requests (key-value pairs)
array<string>
Array of patterns to intercept and block requests (e.g., [“jpg”, “png”])
object
Custom page-load behavior settings
object
Wait condition before scraping
array<object>
Cookies to set for the page request
string
Predefined screen size preset to use instead of specifying width and height manually. Supported values include:
  • QVGA - 320×240
  • VGA - 640×480
  • SVGA - 800×600
  • HD - 1280×720
  • HD+ - 1600×900
  • SXGA - 1280×1024
  • FHD - 1920×1080
  • 2K - 2048×1080
  • 2K QHD - 2560×1440
  • 5K - 5120×2880
  • 4K UHD - 3840×2160
See the full list of screen size presets here
boolean
default:"false"
Whether to emulate a mobile device viewport
number
default:"1"
Device scale factor (minimum: 1)
number
default:"1920"
Viewport width in pixels
number
default:"1080"
Viewport height in pixels
boolean
Whether to force proxy rotation for each request (incurs additional costs)
object
Bring-your-own-proxy configuration
string
required
Your JigsawStack API key

Response Structure

boolean
Indicates whether the call was successful.
object
Usage information for the API call.
string
A unique identifier for the request
array<object>
Detailed scrape data from the page
number
The current page position when paginating through results
number
The total number of pages available
record<string, array<string>>
A map of element prompt keys to arrays of extracted text content from matched elements
record<string, array<string>>
A map of element prompt keys to arrays of CSS selectors that were used to find matching elements
Links detected on the page
object | undefined
Captured browser data if enabled in advance_config
object | undefined
Metadata about the page, such as title, description, keywords, and Open Graph image