Skip to main content
POST
Scrape webpage

Description

This endpoint allows users to scrape data from a specified URL, format the scraped data, and optionally clean it before returning the result.

Endpoint

Headers

  • Content-Type: application/json
  • Authorization: Bearer <API_KEY> (required)

Request Body

Responses

Success (200)

Returns the scraped data in the specified format.
  • Content-Type: application/json
  • X-RateLimit-Limit: The rate limit for the user.
  • X-RateLimit-Remaining: The remaining number of requests for the user.

Example Request

Rate Limiting

Rate limit headers (X-RateLimit-Limit and X-RateLimit-Remaining) are included in the response to indicate the user’s current rate limit status.

Notes

  • This endpoint uses 10 credits per request.
  • Disable JavaScript rendering by setting renderJs to false for faster results if you don’t need it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required

The URL to scrape

format
enum<string>
default:markdown

Output format for the scraped content

Available options:
markdown,
html,
screenshot
cleaned
boolean
default:true

Whether to return cleaned/simplified content

renderJs
boolean
default:true

Whether to execute JavaScript on the page before scraping

requestSource
enum<string>

Optional identifier describing where the API request originated.

Available options:
API,
WEB,
MAKE_DOT_COM,
ZAPIER,
N8N,
PLAYGROUND,
DEFAULT_AUTOMATION,
AGENT_PREVIEW,
AGENT_LIVE,
AUTOPILOT,
STUDIO

Response

Scraped content returned.

title
string

Page title

url
string<uri>

Final URL after redirects

content
string

Scraped content in requested format

metadata
object

Additional page metadata