Skip to main content
POST
Scrape a webpage meta with custom options

Authorizations

x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
url
string
required

Target URL

Example:

"https://example.com"

device
enum<string>
default:desktop

Device type to emulate. Defaults to desktop.

Available options:
desktop,
mobile
Example:

"desktop"

blockAds
boolean
default:true

Whether to block ads

Example:

true

renderJS
boolean
default:true

Whether to render JavaScript

Example:

true

proxyCountry
string

Proxy country code to route the request

Example:

"us"

format
enum<string>
default:json

Format of the scraped result. Defaults to html.

Available options:
markdown,
json
Example:

"json"

fileOutput
boolean
default:false

Whether to get response in file format

Example:

false

Response

Successfully scraped webpage meta

timestamp
number
required

Timestamp of the request in milliseconds

Example:

1783063255117

apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

apiCode
number
required

API status code

Example:

200

meta
object
required

Metadata about the request

data
required

Scraped data (URL or inline content depending on output)

Example:

"https://cdn.geekflare.com/tests/webscraping/ZuyhINuAZPQQabbN"