gateway

POST /

Request

Base URL
https://api.mrscraper.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/mrscraper/apis/scraper-service-gateway-api/docs/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

asyncboolean

Queue the scrape and return a task ID immediately

betaboolean

Set false to use the legacy browser engine instead of the sync scraper; alternatively set beta: false in the JSON body

maxAgeinteger

Shared result cache, in milliseconds (also a top-level JSON body field on POST). 0 or absent: always scrape. N: answer from the latest cached scrape if it is at most N ms old (max 7 days), otherwise scrape and refresh it for everyone (X-Cache: HIT/MISS/BYPASS, Age). Billed like an uncached scrape

Request body

actionstring

agentstring

domainstring

promptstring

streamboolean

task_detailsobject

token_usageinteger

urlstring

Example request

{
  "action": "job_search",
  "agent": "general",
  "domain": "example.com",
  "prompt": "get all property details",
  "token_usage": 42,
  "url": "https://example.com"
}

Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.