Scrape

PreviousSessions NextCrawl

Last updated 1 month ago

Get scrape job status and result

get

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Scrape job details

application/json

404

Job not found

application/json

500

Server error

application/json

get

GET /api/scrape/{id} HTTP/1.1
Host: api.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 batch scrape job status

get

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Batch scrape job status

application/json

404

Batch scrape job not found

application/json

500

Server error

application/json

get

GET /api/scrape/batch/{id}/status HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "status": "pending"
}

Get batch scrape job status and results

get

Authorizations

Path parameters

idstringRequired

Responses

200

Batch scrape job details

application/json

400

Invalid request parameters

application/json

404

Batch scrape job not found

application/json

500

Server error

application/json

get

GET /api/scrape/batch/{id} HTTP/1.1
Host: api.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
}

Get scrape job status

get

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Scrape job status

application/json

404

Job not found

application/json

500

Server error

application/json

get

GET /api/scrape/{id}/status HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "status": "pending"
}

Create new scrape job

post

Authorizations

Body

urlstring · min: 1Required

Responses

200

Scrape job created

application/json

400

Invalid request parameters

application/json

500

Server error

application/json

post

POST /api/scrape HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 937

{
  "url": "text",
  "sessionOptions": {
    "useStealth": false,
    "useProxy": false,
    "proxyServer": "text",
    "proxyServerPassword": "text",
    "proxyServerUsername": "text",
    "proxyCountry": "AD",
    "proxyState": "AL",
    "proxyCity": "new york",
    "operatingSystems": [
      "windows"
    ],
    "device": [
      "desktop"
    ],
    "platform": [
      "chrome"
    ],
    "locales": [
      "aa"
    ],
    "screen": {
      "width": 1280,
      "height": 720
    },
    "solveCaptchas": false,
    "adblock": false,
    "trackers": false,
    "annoyances": false,
    "enableWebRecording": true,
    "enableVideoWebRecording": false,
    "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": 0,
    "timeout": 30000,
    "waitUntil": "load",
    "screenshotOptions": {
      "fullPage": false,
      "format": "webp"
    }
  }
}

{
  "jobId": "text"
}

Start a batch scrape job

post

Authorizations

Body

urlsstring[]Required

Responses

200

Batch scrape job started successfully

application/json

400

Invalid request parameters

application/json

402

Insufficient plan

application/json

429

Too many concurrent batch scrape jobs

application/json

500

Server error

application/json

post

POST /api/scrape/batch HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 940

{
  "urls": [
    "text"
  ],
  "sessionOptions": {
    "useStealth": false,
    "useProxy": false,
    "proxyServer": "text",
    "proxyServerPassword": "text",
    "proxyServerUsername": "text",
    "proxyCountry": "AD",
    "proxyState": "AL",
    "proxyCity": "new york",
    "operatingSystems": [
      "windows"
    ],
    "device": [
      "desktop"
    ],
    "platform": [
      "chrome"
    ],
    "locales": [
      "aa"
    ],
    "screen": {
      "width": 1280,
      "height": 720
    },
    "solveCaptchas": false,
    "adblock": false,
    "trackers": false,
    "annoyances": false,
    "enableWebRecording": true,
    "enableVideoWebRecording": false,
    "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": 0,
    "timeout": 30000,
    "waitUntil": "load",
    "screenshotOptions": {
      "fullPage": false,
      "format": "webp"
    }
  }
}

{
  "jobId": "text"
}