Quickstart

Call it with no key

curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Content-Type: application/json" \
  -d '{"url":"https://bun.com/docs/runtime/bunfig"}'

Response

This real response is cut to a few fields.

{
  "success": true,
  "data": {
    "markdown": "# bunfig.toml\n\nConfigure Bun's behavior using its configuration file bunfig.toml\n\n`bunfig.toml` is Bun's configuration…",
    "metadata": {
      "title": "bunfig.toml | Bun Docs",
      "sourceURL": "https://bun.com/docs/runtime/bunfig",
      "url": "https://bun.com/docs/runtime/bunfig",
      "statusCode": 200,
      "contentType": "text/html",
      "cacheState": "hit",
      "scrapeId": "f82a75f2-1f53-4abb-ac5a-9fdbc4314549",
      "creditsUsed": 0
    }
  }
}

That is the page as markdown. Search, scrape, map and parse work like this with no key, up to 10 calls a minute and 50 a day. See Rate limits.

Get a key

Sign up at stophy.dev/signup. Your account starts with 5,000 free credits, and most calls cost 1 credit. Create a key and save it as STOPHY_API_KEY. An agent can get a key with no human at the keyboard: Sign up returns a link for its person to approve.

Call it with your key

curl -X POST https://api.stophy.dev/v1/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"nvidia earnings","sources":["web","news"],"limit":5}'

const response = await fetch("https://api.stophy.dev/v1/search", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "nvidia earnings",
    sources: ["web", "news"],
    limit: 5,
  }),
});
console.log(await response.json());

import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/search",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={
        "query": "nvidia earnings",
        "sources": ["web", "news"],
        "limit": 5,
    },
)
print(response.json())

Response

This real response is cut to one result per source.

{
  "success": true,
  "data": {
    "news": [
      {
        "title": "Stocks making the biggest moves midday: Micron, Tesla, Tripadvisor, AppLovin, Nvidia & more",
        "url": "https://www.cnbc.com/2026/11/05/stocks-making-the-biggest-moves-midday-mu-tsla-trip-app-nvda.html",
        "snippet": "Here are some of the companies making headlines in midday trading.",
        "date": "2026-11-05T18:35:11.000Z",
        "position": 1
      }
    ],
    "web": [
      {
        "url": "https://nvidianews.nvidia.com/news/nvidia-announces-financial-results-for-second-quarter-fiscal-2027",
        "title": "NVIDIA Announces Financial Results for Second Quarter Fiscal ...",
        "description": "GAAP and non-GAAP earnings per diluted share were $2.46 and $2.22, respectively.\n\n“AI has reached its inflection…",
        "position": 1
      }
    ]
  },
  "creditsUsed": 4
}

creditsUsed is what the call cost in credits. This search of web and news cost 4: 2 credits for each source. See Pricing.

Read a site as JSON

To get a site’s own data, send its page to scrape with a parser:

curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.reddit.com/search/?q=web+scraping&sort=top&t=year","formats":[{"type":"json","parser":"reddit-search"}]}'

The posts come back in data.json. See Parsers.

Crawl a site

Crawl reads many pages in the background. Start it, poll about every 2 seconds until it is completed, then read the pages. Send scrapeOptions.formats to read more than markdown, for example ["markdown","links"], and each page in data has every format the crawl read. Starting is free, and each page costs 1 credit.

ID=$(curl -s -X POST https://api.stophy.dev/v1/crawl \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://bun.com/docs","limit":10}' | jq -r .id)

until [ "$(curl -s https://api.stophy.dev/v1/crawl/$ID -H "Authorization: Bearer $STOPHY_API_KEY" | jq -r .status)" != scraping ]; do sleep 2; done

curl -s https://api.stophy.dev/v1/crawl/$ID -H "Authorization: Bearer $STOPHY_API_KEY" | jq '{status, completed, pages: [.data[].metadata.url], next}'

A status answer holds up to 100 finished pages. If it has next, call that URL for the rest. See Page through results.

Scrape many pages

Batch scrape takes a list of URLs and works the same way. Poll https://api.stophy.dev/v1/batch/scrape/<id> about every 2 seconds until status is completed. Each page in data has the same shape as a scrape.

curl -X POST https://api.stophy.dev/v1/batch/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://bun.com/docs/runtime/bunfig","https://bun.com/docs/runtime/env"]}'

Parsers

Read Reddit, YouTube, Google Maps and 100 more sites as JSON.

Crawl a site

Read every page of a site in the background.

Get started

Parsers

Guides

Plans and billing

Call it with no key

Get a key

Call it with your key

Read a site as JSON

Crawl a site

Scrape many pages

Next

Parsers

Crawl a site

​Call it with no key

​Get a key

​Call it with your key

​Read a site as JSON

​Crawl a site

​Scrape many pages

​Next

Parsers

Crawl a site

Call it with no key

Get a key

Call it with your key

Read a site as JSON

Crawl a site

Scrape many pages

Next