Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hyperbrowser Scrape API

Single-page and batch scrape jobs returning HTML, Markdown, links, and screenshots with asynchronous status polling.

Hyperbrowser Scrape API is one of 12 APIs that Hyperbrowser publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Scrape, Web Scraping, and Batch. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 6 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.hyperbrowser.ai.

6 operations 6 paths 22 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hyperbrowser.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hyperbrowser Scrape API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Account API key from app.hyperbrowser.ai

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Scrape 6
POST
/api/scrape
Create new scrape job
body → 200400500
GET
/api/scrape/{id}
Get scrape job status and result
1 param → 200404500
GET
/api/scrape/{id}/status
Get scrape job status
1 param → 200404500
POST
/api/scrape/batch
Start a batch scrape job
body → 200400402429500
GET
/api/scrape/batch/{id}
Get batch scrape job status and results
1 param → 200400404500
GET
/api/scrape/batch/{id}/status
Get batch scrape job status
1 param → 200404500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are CreateSessionParams (37 properties), ScrapeOptions (9 properties), ScrapedPage (8 properties), BatchScrapeJobResponse (8 properties). Each schema is shown below with its type and property counts.

ScrapeJobData
object
5 properties
StartScrapeJobParams
object
3 properties 1 required
JobStatus
string
ScrapeOptions
object
9 properties
StartBatchScrapeJobResponse
object
1 property 1 required
ProxyCountry
string
ScrapeJobResponse
object
4 properties 2 required
Device
string
CreateSessionProfile
object
3 properties
SessionRegion
string
ProxyState
string
Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.
ScreenConfig
object
2 properties
ISO639_1
string
BatchScrapeJobResponse
object
8 properties
StartBatchScrapeJobParams
object
3 properties 1 required
StartScrapeJobResponse
object
1 property
CreateSessionParams
object
37 properties
JobStatusResponse
object
1 property 1 required
Platform
string
OperatingSystem
string
ScrapedPage
object
8 properties 2 required
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperbrowser-scrape-api-openapi.yml Raw ↑

Other APIs Hyperbrowser publishes across the network.

Hyperbrowser Sessions API
Hyperbrowser Profiles API
Hyperbrowser Crawl API
Hyperbrowser Extract API
Hyperbrowser Agents API
Hyperbrowser Extensions API
Hyperbrowser Web API
Hyperbrowser Profile API
Hyperbrowser Session API
Hyperbrowser Task API
Hyperbrowser X402 API