Batch scrape status

curl https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ \
  -H "Authorization: Bearer $STOPHY_API_KEY"

const response = await fetch("https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ", {
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
)
print(response.json())

{
  "success": true,
  "status": "completed",
  "total": 2,
  "completed": 2,
  "creditsUsed": 1,
  "createdAt": "2026-11-05T23:35:30.889Z",
  "completedAt": "2026-11-05T23:35:32.943Z",
  "duration": 2.054,
  "expiresAt": "2026-11-06T23:35:30.889Z",
  "data": [
    {
      "markdown": "# bunfig.toml\n\nConfigure Bun's behavior using its configuration file bunfig.toml\n\n`bunfig.toml` is Bun's configuration…",
      "metadata": {
        "viewport": "width=device-width, initial-scale=1",
        "theme-color": [
          "#ffffff",
          "#0d0a0c"
        ],
        "og:type": "website",
        "og:image": "https://bun.com/og/docs/runtime/bunfig.png",
        "twitter:site": "@bunjavascript",
        "twitter:card": "summary_large_image",
        "ogTitle": "bunfig.toml | Bun Docs",
        "ogDescription": "Configure Bun's behavior using its configuration file bunfig.toml",
        "ogUrl": "https://bun.com/docs/runtime/bunfig",
        "ogLocale": "en_US",
        "ogSiteName": "Bun",
        "favicon": "https://bun.com/favicon.ico",
        "title": "bunfig.toml | Bun Docs",
        "description": "Configure Bun's behavior using its configuration file bunfig.toml",
        "language": "en",
        "ogImage": "https://bun.com/og/docs/runtime/bunfig.png",
        "sourceURL": "https://bun.com/docs/runtime/bunfig",
        "url": "https://bun.com/docs/runtime/bunfig",
        "statusCode": 200,
        "contentType": "text/html",
        "cacheState": "hit",
        "cachedAt": "2026-11-05T19:33:09.837Z",
        "scrapeId": "job_385XD5MMpQfsXsGFdTO9vQ",
        "creditsUsed": 0
      }
    }
  ]
}

GET

batch

scrape

{id}

curl https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ \
  -H "Authorization: Bearer $STOPHY_API_KEY"

const response = await fetch("https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ", {
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
)
print(response.json())

{
  "success": true,
  "status": "completed",
  "total": 2,
  "completed": 2,
  "creditsUsed": 1,
  "createdAt": "2026-11-05T23:35:30.889Z",
  "completedAt": "2026-11-05T23:35:32.943Z",
  "duration": 2.054,
  "expiresAt": "2026-11-06T23:35:30.889Z",
  "data": [
    {
      "markdown": "# bunfig.toml\n\nConfigure Bun's behavior using its configuration file bunfig.toml\n\n`bunfig.toml` is Bun's configuration…",
      "metadata": {
        "viewport": "width=device-width, initial-scale=1",
        "theme-color": [
          "#ffffff",
          "#0d0a0c"
        ],
        "og:type": "website",
        "og:image": "https://bun.com/og/docs/runtime/bunfig.png",
        "twitter:site": "@bunjavascript",
        "twitter:card": "summary_large_image",
        "ogTitle": "bunfig.toml | Bun Docs",
        "ogDescription": "Configure Bun's behavior using its configuration file bunfig.toml",
        "ogUrl": "https://bun.com/docs/runtime/bunfig",
        "ogLocale": "en_US",
        "ogSiteName": "Bun",
        "favicon": "https://bun.com/favicon.ico",
        "title": "bunfig.toml | Bun Docs",
        "description": "Configure Bun's behavior using its configuration file bunfig.toml",
        "language": "en",
        "ogImage": "https://bun.com/og/docs/runtime/bunfig.png",
        "sourceURL": "https://bun.com/docs/runtime/bunfig",
        "url": "https://bun.com/docs/runtime/bunfig",
        "statusCode": 200,
        "contentType": "text/html",
        "cacheState": "hit",
        "cachedAt": "2026-11-05T19:33:09.837Z",
        "scrapeId": "job_385XD5MMpQfsXsGFdTO9vQ",
        "creditsUsed": 0
      }
    }
  ]
}

Free.

Pages

Poll until status is completed, then call next until it is gone. Each answer holds up to 100 finished pages. A page’s address is in metadata.url. See Page through results. failed counts the pages that could not be read. errors lists the failed pages in this answer with url, code, message, retryable and at, and error is set only when the whole job failed. For every failed page, call Batch scrape errors.

curl https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ \
  -H "Authorization: Bearer $STOPHY_API_KEY"

const response = await fetch("https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ", {
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.stophy.dev/v1/batch/scrape/job_385XD5MMpQfsXsGFdTO9vQ",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
)
print(response.json())

{
  "success": true,
  "status": "completed",
  "total": 2,
  "completed": 2,
  "creditsUsed": 1,
  "createdAt": "2026-11-05T23:35:30.889Z",
  "completedAt": "2026-11-05T23:35:32.943Z",
  "duration": 2.054,
  "expiresAt": "2026-11-06T23:35:30.889Z",
  "data": [
    {
      "markdown": "# bunfig.toml\n\nConfigure Bun's behavior using its configuration file bunfig.toml\n\n`bunfig.toml` is Bun's configuration…",
      "metadata": {
        "viewport": "width=device-width, initial-scale=1",
        "theme-color": [
          "#ffffff",
          "#0d0a0c"
        ],
        "og:type": "website",
        "og:image": "https://bun.com/og/docs/runtime/bunfig.png",
        "twitter:site": "@bunjavascript",
        "twitter:card": "summary_large_image",
        "ogTitle": "bunfig.toml | Bun Docs",
        "ogDescription": "Configure Bun's behavior using its configuration file bunfig.toml",
        "ogUrl": "https://bun.com/docs/runtime/bunfig",
        "ogLocale": "en_US",
        "ogSiteName": "Bun",
        "favicon": "https://bun.com/favicon.ico",
        "title": "bunfig.toml | Bun Docs",
        "description": "Configure Bun's behavior using its configuration file bunfig.toml",
        "language": "en",
        "ogImage": "https://bun.com/og/docs/runtime/bunfig.png",
        "sourceURL": "https://bun.com/docs/runtime/bunfig",
        "url": "https://bun.com/docs/runtime/bunfig",
        "statusCode": 200,
        "contentType": "text/html",
        "cacheState": "hit",
        "cachedAt": "2026-11-05T19:33:09.837Z",
        "scrapeId": "job_385XD5MMpQfsXsGFdTO9vQ",
        "creditsUsed": 0
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

cursor

string

Response

The data, and the credits this call used.

success

boolean

required

status

enum<string>

required

Available options:

scraping,

completed,

failed,

cancelled

total

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

completed

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

failed

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

errors

object[]

required

Show child attributes

creditsUsed

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

data

object[]

required

Show child attributes

error

string

createdAt

string

completedAt

string

duration

number

expiresAt

string

Using the API

Read pages

Crawl a site

Batch scrape

Extract

Browser tasks

Catalog

Account

Batch scrape status

Pages

Authorizations

Path Parameters

Query Parameters

Response

​Pages

Authorizations

Path Parameters

Query Parameters

Response

Pages