gateway
GET /
Request
- Base URLhttps://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
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
urlstring required
Target URL to forward to (URL encoded)
tokenstring
atk_example_not_a_real_token
asyncboolean
Queue the scrape and return a task ID immediately
betaboolean
Set false to use the legacy browser engine instead of the sync scraper (async, callbacks, markdown and workflows always use it)
detectedJsonboolean
Extract JSON from <script> tags and metadata from <meta> tags in HTML response
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
Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.