Scrape
Last updated
Last updated
GET /api/scrape/{id} HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
"jobId": "text",
"status": "pending",
"data": {
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"markdown": "text",
"html": "text",
"links": [
"text"
],
"screenshot": "text"
},
"error": "text"
}GET /api/scrape/batch/{id} HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
"jobId": "text",
"status": "pending",
"data": [
{
"url": "text",
"status": "pending",
"error": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"markdown": "text",
"html": "text",
"links": [
"text"
],
"screenshot": "text"
}
],
"error": "text",
"totalScrapedPages": 1,
"totalPageBatches": 1,
"currentPageBatch": 1,
"batchSize": 1
}POST /api/scrape HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 889
{
"url": "text",
"sessionOptions": {
"useStealth": true,
"useProxy": true,
"proxyServer": "text",
"proxyServerPassword": "text",
"proxyServerUsername": "text",
"proxyCountry": "AD",
"proxyState": "AL",
"proxyCity": "new york",
"operatingSystems": [
"windows"
],
"device": [
"desktop"
],
"platform": [
"chrome"
],
"locales": [
"aa"
],
"screen": {
"width": 1,
"height": 1
},
"solveCaptchas": true,
"adblock": true,
"trackers": true,
"annoyances": true,
"enableWebRecording": true,
"profile": {
"id": "text",
"persistChanges": true
},
"acceptCookies": true,
"extensionIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"urlBlocklist": [
"text"
],
"browserArgs": [
"text"
],
"imageCaptchaParams": [
{
"imageSelector": "text",
"inputSelector": "text"
}
],
"timeoutMinutes": 1
},
"scrapeOptions": {
"formats": [
"html"
],
"includeTags": [
"text"
],
"excludeTags": [
"text"
],
"onlyMainContent": true,
"waitFor": 1,
"timeout": 1,
"waitUntil": "load",
"screenshotOptions": {
"fullPage": true,
"format": "jpeg"
}
}
}{
"jobId": "text"
}POST /api/scrape/batch HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 892
{
"urls": [
"text"
],
"sessionOptions": {
"useStealth": true,
"useProxy": true,
"proxyServer": "text",
"proxyServerPassword": "text",
"proxyServerUsername": "text",
"proxyCountry": "AD",
"proxyState": "AL",
"proxyCity": "new york",
"operatingSystems": [
"windows"
],
"device": [
"desktop"
],
"platform": [
"chrome"
],
"locales": [
"aa"
],
"screen": {
"width": 1,
"height": 1
},
"solveCaptchas": true,
"adblock": true,
"trackers": true,
"annoyances": true,
"enableWebRecording": true,
"profile": {
"id": "text",
"persistChanges": true
},
"acceptCookies": true,
"extensionIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"urlBlocklist": [
"text"
],
"browserArgs": [
"text"
],
"imageCaptchaParams": [
{
"imageSelector": "text",
"inputSelector": "text"
}
],
"timeoutMinutes": 1
},
"scrapeOptions": {
"formats": [
"html"
],
"includeTags": [
"text"
],
"excludeTags": [
"text"
],
"onlyMainContent": true,
"waitFor": 1,
"timeout": 1,
"waitUntil": "load",
"screenshotOptions": {
"fullPage": true,
"format": "jpeg"
}
}
}{
"jobId": "text"
}