API Reference
Scrape
API Reference
Scrape
Scrape the content of a given URL within the session’s environment. If a session_id is not provided, a new session is created. If a session_id is provided and no url is provided, the current page in the session is scraped.
POST
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
If True, the session will not be closed after the operation is completed.
The maximum number of actions to list after which the listing will stop. Used when min_nb_actions is not provided.
The minimum number of actions to list before stopping. If not provided, the listing will continue until the maximum number of actions is reached.
Whether to only scrape the main content of the page. If True, navbars, footers, etc. are excluded.
Whether to scrape images from the page. Images are not scraped by default.
Whether to include a screenshot in the response.
The ID of the session. A new session is created when not provided.
Session timeout in minutes. Cannot exceed the global timeout.
Required range:
0 < x < 30The URL to observe. If not provided, uses the current page URL.
Response
200 - application/json
Metadata of the current page, i.e url, page title, snapshot timestamp.
Browser session information
Extracted data from the page
Base64 encoded screenshot of the current page
Available actions in the current state