Skip to main content
The API takes JSON over HTTPS at https://api.stophy.dev and answers in JSON. Send your key as Authorization: Bearer $STOPHY_API_KEY, from Get credentials. Use the body or query string shown on each operation’s page. A field the operation does not take can return 400. The OpenAPI document describes every operation and field. Generate a client from it, or give it to a model.

Operations

The sidebar lists every operation by group: scrape, map, crawl, search, extract, agent, parse, browser sessions, profiles, extensions, network policies and tasks, batches, monitors, webhooks, logs, usage, account, catalog and feedback. A site’s own data, like a Reddit search or a YouTube transcript, comes from scrape with a pre-built parser.

Responses

Check success before you read the result. A job start answers with its job id, and job status pages keep their running totals. This Map answer is cut to one link.
Headers on an answer:
  • X-Request-ID names the request. Quote it to support.
  • x-cost-usd is what the call cost, in dollars. See Pricing.
  • X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. See Rate limits.
  • x-cache and x-cache-age on some operations: whether the result came from a stored copy.
Add ?maxTextLength=<characters> to cut long text. A cut value ends with …, and a page whose text was cut has isTruncated: true. A screenshot is never cut. When an answer has a cursor, send it back unchanged with the same input for the next page. Where it has a page, send the next number. Crawl and batch status answers use next. Paging needs a key. A failed call returns an error status and a flat body, { "success": false, "error": "...", "code": "..." }. See Errors.