JavaScript
import { Hyperbrowser } from '@hyperbrowser/sdk';
const client = new Hyperbrowser({ apiKey: 'your-api-key' });
await client.scrape.start({
url: 'https://example.com',
scrapeOptions: {
formats: ['markdown']
}
});from hyperbrowser import Hyperbrowser
from hyperbrowser.models import StartScrapeJobParams, ScrapeOptions
client = Hyperbrowser(api_key='your-api-key')
client.scrape.start(StartScrapeJobParams(
url='https://example.com',
scrape_options=ScrapeOptions(
formats=['markdown']
)
))curl --request POST \
--url https://api.hyperbrowser.ai/api/scrape \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "<string>",
"sessionOptions": {
"useStealth": false,
"useProxy": false,
"acceptCookies": false
},
"scrapeOptions": {
"formats": [
"markdown"
],
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"onlyMainContent": true,
"waitFor": 0,
"timeout": 30000,
"waitUntil": "load",
"screenshotOptions": {
"fullPage": false,
"format": "webp",
"cropToContent": false,
"cropToContentMaxHeight": 123,
"cropToContentMinHeight": 123
},
"storageState": {
"localStorage": {},
"sessionStorage": {}
}
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperbrowser.ai/api/scrape",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'sessionOptions' => [
'useStealth' => false,
'useProxy' => false,
'acceptCookies' => false
],
'scrapeOptions' => [
'formats' => [
'markdown'
],
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'onlyMainContent' => true,
'waitFor' => 0,
'timeout' => 30000,
'waitUntil' => 'load',
'screenshotOptions' => [
'fullPage' => false,
'format' => 'webp',
'cropToContent' => false,
'cropToContentMaxHeight' => 123,
'cropToContentMinHeight' => 123
],
'storageState' => [
'localStorage' => [
],
'sessionStorage' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperbrowser.ai/api/scrape"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"sessionOptions\": {\n \"useStealth\": false,\n \"useProxy\": false,\n \"acceptCookies\": false\n },\n \"scrapeOptions\": {\n \"formats\": [\n \"markdown\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": true,\n \"waitFor\": 0,\n \"timeout\": 30000,\n \"waitUntil\": \"load\",\n \"screenshotOptions\": {\n \"fullPage\": false,\n \"format\": \"webp\",\n \"cropToContent\": false,\n \"cropToContentMaxHeight\": 123,\n \"cropToContentMinHeight\": 123\n },\n \"storageState\": {\n \"localStorage\": {},\n \"sessionStorage\": {}\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperbrowser.ai/api/scrape")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"sessionOptions\": {\n \"useStealth\": false,\n \"useProxy\": false,\n \"acceptCookies\": false\n },\n \"scrapeOptions\": {\n \"formats\": [\n \"markdown\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": true,\n \"waitFor\": 0,\n \"timeout\": 30000,\n \"waitUntil\": \"load\",\n \"screenshotOptions\": {\n \"fullPage\": false,\n \"format\": \"webp\",\n \"cropToContent\": false,\n \"cropToContentMaxHeight\": 123,\n \"cropToContentMinHeight\": 123\n },\n \"storageState\": {\n \"localStorage\": {},\n \"sessionStorage\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/scrape")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"sessionOptions\": {\n \"useStealth\": false,\n \"useProxy\": false,\n \"acceptCookies\": false\n },\n \"scrapeOptions\": {\n \"formats\": [\n \"markdown\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": true,\n \"waitFor\": 0,\n \"timeout\": 30000,\n \"waitUntil\": \"load\",\n \"screenshotOptions\": {\n \"fullPage\": false,\n \"format\": \"webp\",\n \"cropToContent\": false,\n \"cropToContentMaxHeight\": 123,\n \"cropToContentMinHeight\": 123\n },\n \"storageState\": {\n \"localStorage\": {},\n \"sessionStorage\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"jobId": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Scrape
Create new scrape job
POST
/
api
/
scrape
JavaScript
import { Hyperbrowser } from '@hyperbrowser/sdk';
const client = new Hyperbrowser({ apiKey: 'your-api-key' });
await client.scrape.start({
url: 'https://example.com',
scrapeOptions: {
formats: ['markdown']
}
});from hyperbrowser import Hyperbrowser
from hyperbrowser.models import StartScrapeJobParams, ScrapeOptions
client = Hyperbrowser(api_key='your-api-key')
client.scrape.start(StartScrapeJobParams(
url='https://example.com',
scrape_options=ScrapeOptions(
formats=['markdown']
)
))curl --request POST \
--url https://api.hyperbrowser.ai/api/scrape \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "<string>",
"sessionOptions": {
"useStealth": false,
"useProxy": false,
"acceptCookies": false
},
"scrapeOptions": {
"formats": [
"markdown"
],
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"onlyMainContent": true,
"waitFor": 0,
"timeout": 30000,
"waitUntil": "load",
"screenshotOptions": {
"fullPage": false,
"format": "webp",
"cropToContent": false,
"cropToContentMaxHeight": 123,
"cropToContentMinHeight": 123
},
"storageState": {
"localStorage": {},
"sessionStorage": {}
}
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperbrowser.ai/api/scrape",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'sessionOptions' => [
'useStealth' => false,
'useProxy' => false,
'acceptCookies' => false
],
'scrapeOptions' => [
'formats' => [
'markdown'
],
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'onlyMainContent' => true,
'waitFor' => 0,
'timeout' => 30000,
'waitUntil' => 'load',
'screenshotOptions' => [
'fullPage' => false,
'format' => 'webp',
'cropToContent' => false,
'cropToContentMaxHeight' => 123,
'cropToContentMinHeight' => 123
],
'storageState' => [
'localStorage' => [
],
'sessionStorage' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperbrowser.ai/api/scrape"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"sessionOptions\": {\n \"useStealth\": false,\n \"useProxy\": false,\n \"acceptCookies\": false\n },\n \"scrapeOptions\": {\n \"formats\": [\n \"markdown\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": true,\n \"waitFor\": 0,\n \"timeout\": 30000,\n \"waitUntil\": \"load\",\n \"screenshotOptions\": {\n \"fullPage\": false,\n \"format\": \"webp\",\n \"cropToContent\": false,\n \"cropToContentMaxHeight\": 123,\n \"cropToContentMinHeight\": 123\n },\n \"storageState\": {\n \"localStorage\": {},\n \"sessionStorage\": {}\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperbrowser.ai/api/scrape")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"sessionOptions\": {\n \"useStealth\": false,\n \"useProxy\": false,\n \"acceptCookies\": false\n },\n \"scrapeOptions\": {\n \"formats\": [\n \"markdown\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": true,\n \"waitFor\": 0,\n \"timeout\": 30000,\n \"waitUntil\": \"load\",\n \"screenshotOptions\": {\n \"fullPage\": false,\n \"format\": \"webp\",\n \"cropToContent\": false,\n \"cropToContentMaxHeight\": 123,\n \"cropToContentMinHeight\": 123\n },\n \"storageState\": {\n \"localStorage\": {},\n \"sessionStorage\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/scrape")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"sessionOptions\": {\n \"useStealth\": false,\n \"useProxy\": false,\n \"acceptCookies\": false\n },\n \"scrapeOptions\": {\n \"formats\": [\n \"markdown\"\n ],\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": true,\n \"waitFor\": 0,\n \"timeout\": 30000,\n \"waitUntil\": \"load\",\n \"screenshotOptions\": {\n \"fullPage\": false,\n \"format\": \"webp\",\n \"cropToContent\": false,\n \"cropToContentMaxHeight\": 123,\n \"cropToContentMinHeight\": 123\n },\n \"storageState\": {\n \"localStorage\": {},\n \"sessionStorage\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"jobId": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Was this page helpful?
⌘I