An async JavaScript and TypeScript SDK for the seven MrScraper services.
Seven services share the same descriptions, parameter meanings, and defaults across the CLI, SDKs, and integrations. Names, types, authentication, and code examples follow each surface's conventions. See the API Reference.
| Service | Public name | Description |
|---|---|---|
| Status | status |
Return the raw account status API response without summarizing, redacting body fields, or adding calculated fields. |
| Scrape HTML | scrapeHtml |
Retrieve the raw HTML of a page. Browser rendering is optional. |
| Scrape Markdown | scrapeMarkdown |
Retrieve a page as Markdown. Including HTML also enables browser rendering and returns both outputs as JSON. |
| Get screenshot | getScreenshot |
Capture a base64 screenshot of the full page or top viewport. Browser rendering is always enabled. |
| Scrape brand | scrapeBrand |
Extract a website's colors, typography, logos, and social links as JSON. |
| Scrape JSON | scrapeJson |
Extract structured JSON from a page using a natural-language prompt. Append Json Schema: and a JSON schema to shape the output. |
| Web search | webSearch |
Search the web and return ranked results with titles, URLs, descriptions, and sources. |
Requires Node.js 18 or newer. Examples use ES modules; save executable examples as .mjs files or set "type": "module" in your package.
npm install @mrscraper/sdkObtain an API key from the MrScraper app. API key used to authenticate the request.
export MRSCRAPER_API_TOKEN="YOUR_TOKEN"Each function accepts an optional token: string in its options. Precedence is a nonempty explicit token, MRSCRAPER_API_TOKEN, then MRSCRAPER_API_KEY. Credentials are sent in headers, never in the request URL.
import { scrapeHtml } from "@mrscraper/sdk";
const result = await scrapeHtml("https://example.com", {
browserRendering: true,
warmStart: true,
waitForSelector: "body",
timeout: 120,
maxRetries: 0,
});
console.log(result.data);Examples use example.com as the sample target. Replace it for your use case. Live scraping and search calls consume account quota.
Response examples show selected keys and types observed in live API responses. Values are placeholders; page content, base64 images, and arrays are abbreviated. Actual responses may contain additional fields.
HTML, Markdown, screenshots, and JSON extraction share url, timeout, geoCode, proxyCountry, super, waitUntil, proxy, maxRetries, and saveResult (using the naming style shown below). Page defaults are 300 seconds, US geolocation/proxy country, real-device routing off, and dashboard saving off. Omitted retry limits mean no limit. Exact types, defaults, and standard descriptions appear in each service table.
HTML, Markdown, and screenshots additionally accept blockResources, waitForSelector, and returnCookie. JSON extraction does not accept these controls. Browser rendering is optional for HTML, Markdown, and JSON; screenshots always enable it. Markdown with HTML also enables browser rendering.
Return the raw account status API response without summarizing, redacting body fields, or adding calculated fields.
This service takes no service parameters. Authentication is configured separately.
The HTTP deadline is fixed at 600 seconds. It is not a service parameter.
import { status } from "@mrscraper/sdk";
const result = await status();
console.log(result.data);The API body contains message and data. Account details remain nested in data, including subscriptionItem and scraperAllowance. The response envelope therefore exposes account details at data.data. Sensitive response headers are removed.
Success response
{
"status_code": 200,
"data": {
"message": "Example response",
"data": {
"id": "ACCOUNT_ID",
"tokenLimit": 100000,
"tokenUsage": 2500,
"stripeStatus": "active",
"user": {
"name": "Example user",
"email": "user@example.com",
"isVerified": true
},
"subscriptionItem": {
"name": "Example plan",
"tokenLimit": 100000
},
"scraperAllowance": {
"remaining": 97500,
"plans": [
{
"remaining": 97500
}
]
}
}
},
"headers": {
"content-type": "application/json; charset=utf-8"
}
}Retrieve the raw HTML of a page. Browser rendering is optional.
| Parameter | HTTP field | Type | Default | Description |
|---|---|---|---|---|
url |
url |
string | Required | Absolute HTTP or HTTPS URL of the page to process. |
timeout |
timeout |
number (integer) | 300 |
Page load timeout in seconds, from 1 to 300. The HTTP request allows 30 additional seconds. |
geoCode |
geoCode |
string | "us" |
Two-letter country code to load the page from, sent in lowercase. |
proxyCountry |
proxyCountry |
string | "us" |
Two-letter country code of the proxy server, sent in lowercase. |
super |
super |
boolean | false |
Whether to route the request through real devices. |
waitUntil |
waitUntil |
string: domcontentloaded, load, networkidle0, networkidle2 |
"domcontentloaded" |
Navigation completion event to wait for: domcontentloaded, load, networkidle0, or networkidle2. |
proxy |
proxy |
string | Omitted | Custom proxy URL used to load the page. |
maxRetries |
maxRetries |
number (integer) | Omitted | Maximum number of retries, as a nonnegative integer. Omit this parameter for no limit. |
saveResult |
saveResult |
boolean | false |
Whether to save the result to the dashboard Result tab. |
blockResources |
blockResources |
boolean | false |
Whether to block images, fonts, and stylesheets while loading the page. |
waitForSelector |
waitForSelector |
string | Omitted | Wait for the page to contain the specified CSS selector before returning the result. |
returnCookie |
returnCookie |
boolean | false |
Whether to include browser session cookies in the response. |
browserRendering |
browserRendering |
boolean | false |
Whether to render the page in a browser before returning the result. |
warmStart |
warmStart |
boolean | false |
Whether to enable warm start for more reliable scraping, at the cost of additional latency. |
import { scrapeHtml } from "@mrscraper/sdk";
const result = await scrapeHtml("https://example.com", {
browserRendering: true,
warmStart: true,
waitForSelector: "body",
timeout: 120,
maxRetries: 0,
});
console.log(result.data);The default response body is HTML text. Additional controls can cause the API to return JSON; the returned structure is preserved.
Success response
{
"status_code": 200,
"data": "<html><body>Example page content...</body></html>",
"headers": {
"content-type": "text/html; charset=utf-8"
}
}Retrieve a page as Markdown. Including HTML also enables browser rendering and returns both outputs as JSON.
| Parameter | HTTP field | Type | Default | Description |
|---|---|---|---|---|
url |
url |
string | Required | Absolute HTTP or HTTPS URL of the page to process. |
timeout |
timeout |
number (integer) | 300 |
Page load timeout in seconds, from 1 to 300. The HTTP request allows 30 additional seconds. |
geoCode |
geoCode |
string | "us" |
Two-letter country code to load the page from, sent in lowercase. |
proxyCountry |
proxyCountry |
string | "us" |
Two-letter country code of the proxy server, sent in lowercase. |
super |
super |
boolean | false |
Whether to route the request through real devices. |
waitUntil |
waitUntil |
string: domcontentloaded, load, networkidle0, networkidle2 |
"domcontentloaded" |
Navigation completion event to wait for: domcontentloaded, load, networkidle0, or networkidle2. |
proxy |
proxy |
string | Omitted | Custom proxy URL used to load the page. |
maxRetries |
maxRetries |
number (integer) | Omitted | Maximum number of retries, as a nonnegative integer. Omit this parameter for no limit. |
saveResult |
saveResult |
boolean | false |
Whether to save the result to the dashboard Result tab. |
blockResources |
blockResources |
boolean | false |
Whether to block images, fonts, and stylesheets while loading the page. |
waitForSelector |
waitForSelector |
string | Omitted | Wait for the page to contain the specified CSS selector before returning the result. |
returnCookie |
returnCookie |
boolean | false |
Whether to include browser session cookies in the response. |
browserRendering |
browserRendering |
boolean | false |
Whether to render the page in a browser before returning the result. |
warmStart |
warmStart |
boolean | false |
Whether to enable warm start for more reliable scraping, at the cost of additional latency. |
html |
html |
boolean | false |
Whether to include the page HTML in the response. |
import { scrapeMarkdown } from "@mrscraper/sdk";
const result = await scrapeMarkdown("https://example.com", {
html: true,
warmStart: true,
});
console.log(result.data);The default response body is Markdown text. Enabling HTML returns JSON containing both HTML and Markdown.
With html enabled
{
"status_code": 200,
"data": {
"html": "<html>...</html>",
"markdown": "# Example page\n\n..."
},
"headers": {
"content-type": "application/json"
}
}Default Markdown text
{
"status_code": 200,
"data": "# Example page\n\nExample Markdown content...",
"headers": {
"content-type": "text/markdown; charset=utf-8"
}
}Capture a base64 screenshot of the full page or top viewport. Browser rendering is always enabled.
| Parameter | HTTP field | Type | Default | Description |
|---|---|---|---|---|
url |
url |
string | Required | Absolute HTTP or HTTPS URL of the page to process. |
timeout |
timeout |
number (integer) | 300 |
Page load timeout in seconds, from 1 to 300. The HTTP request allows 30 additional seconds. |
geoCode |
geoCode |
string | "us" |
Two-letter country code to load the page from, sent in lowercase. |
proxyCountry |
proxyCountry |
string | "us" |
Two-letter country code of the proxy server, sent in lowercase. |
super |
super |
boolean | false |
Whether to route the request through real devices. |
waitUntil |
waitUntil |
string: domcontentloaded, load, networkidle0, networkidle2 |
"domcontentloaded" |
Navigation completion event to wait for: domcontentloaded, load, networkidle0, or networkidle2. |
proxy |
proxy |
string | Omitted | Custom proxy URL used to load the page. |
maxRetries |
maxRetries |
number (integer) | Omitted | Maximum number of retries, as a nonnegative integer. Omit this parameter for no limit. |
saveResult |
saveResult |
boolean | false |
Whether to save the result to the dashboard Result tab. |
blockResources |
blockResources |
boolean | false |
Whether to block images, fonts, and stylesheets while loading the page. |
waitForSelector |
waitForSelector |
string | Omitted | Wait for the page to contain the specified CSS selector before returning the result. |
returnCookie |
returnCookie |
boolean | false |
Whether to include browser session cookies in the response. |
screenshot |
screenshot |
string: full, top |
"full" |
Screenshot area to capture: full for the entire page or top for the top viewport. |
html |
html |
boolean | true |
Whether to include the page HTML in the response. |
markdown |
markdown |
boolean | false |
Whether to include the page Markdown in the response. |
import { getScreenshot } from "@mrscraper/sdk";
const result = await getScreenshot("https://example.com", {
screenshot: "top",
html: false,
markdown: true,
});
console.log(result.data);The response body contains a base64 screenshot and requested page outputs. The API can still include HTML when HTML output is disabled.
Success response
{
"status_code": 200,
"data": {
"html": "<html>...</html>",
"screenshot": "BASE64_PNG_DATA",
"markdown": "# Example page\n\n..."
},
"headers": {
"content-type": "application/json; charset=utf-8"
}
}Extract a website's colors, typography, logos, and social links as JSON.
| Parameter | HTTP field | Type | Default | Description |
|---|---|---|---|---|
url |
url |
string | Required | Absolute HTTP or HTTPS URL of the page to process. |
The HTTP deadline is fixed at 120 seconds. It is not a service parameter.
The request uses action=brand-scraping and bundle=none; page controls are not accepted.
import { scrapeBrand } from "@mrscraper/sdk";
const result = await scrapeBrand("https://example.com");
console.log(result.data);The API body contains message and a data object with job_id, status, url, final_url, brand, and error. Brand details are available at data.data.brand in the response envelope.
Success response
{
"status_code": 200,
"data": {
"data": {
"job_id": "JOB_ID",
"status": "succeeded",
"url": "https://example.com",
"final_url": "https://example.com",
"brand": {
"name": "Example brand",
"colors": {
"background": "#ffffff",
"text": "#222222"
},
"typography": {
"body": {
"font_family": "Example font"
}
}
},
"error": null,
"bundle_url": null
},
"message": "Example response"
},
"headers": {
"content-type": "application/json"
}
}Extract structured JSON from a page using a natural-language prompt. Append Json Schema: and a JSON schema to shape the output.
| Parameter | HTTP field | Type | Default | Description |
|---|---|---|---|---|
url |
url |
string | Required | Absolute HTTP or HTTPS URL of the page to process. |
timeout |
timeout |
number (integer) | 300 |
Page load timeout in seconds, from 1 to 300. The HTTP request allows 30 additional seconds. |
geoCode |
geoCode |
string | "us" |
Two-letter country code to load the page from, sent in lowercase. |
proxyCountry |
proxyCountry |
string | "us" |
Two-letter country code of the proxy server, sent in lowercase. |
super |
super |
boolean | false |
Whether to route the request through real devices. |
waitUntil |
waitUntil |
string: domcontentloaded, load, networkidle0, networkidle2 |
"domcontentloaded" |
Navigation completion event to wait for: domcontentloaded, load, networkidle0, or networkidle2. |
proxy |
proxy |
string | Omitted | Custom proxy URL used to load the page. |
maxRetries |
maxRetries |
number (integer) | Omitted | Maximum number of retries, as a nonnegative integer. Omit this parameter for no limit. |
saveResult |
saveResult |
boolean | false |
Whether to save the result to the dashboard Result tab. |
prompt |
prompt |
string | "Extract all data as complete as possible." |
Instructions describing the data to extract. Append Json Schema: and a JSON schema to shape the output. |
browserRendering |
browserRendering |
boolean | false |
Whether to render the page in a browser before returning the result. |
html |
html |
boolean | false |
Whether to include the page HTML in the response. |
screenshot |
screenshot |
boolean | false |
Whether to include a base64 screenshot in the response. |
The request uses agent=general and GET. If the encoded URL exceeds 8,000 characters, it switches to POST with url, prompt, and agent in the body; page controls remain in the query.
import { scrapeJson } from "@mrscraper/sdk";
const result = await scrapeJson("https://example.com", {
prompt:
'Extract the first 2 items with title and price. Json Schema: {"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"price":{"type":"string"}},"required":["title","price"]}}',
browserRendering: true,
});
console.log(result.data);Extraction results are in the API body's data field and follow the requested schema. Response metadata includes thread_id, token_usage, status, error, runtime, and cookies. html, markdown, and screenshot can be empty strings when not requested.
Success response
{
"status_code": 200,
"data": {
"success": true,
"data": [
{
"title": "Example item",
"price": "10.00"
}
],
"thread_id": "THREAD_ID",
"token_usage": 1,
"html": "",
"markdown": "",
"screenshot": "",
"status": "Results ready",
"error": "",
"runtime": 1.23,
"cookies": []
},
"headers": {
"content-type": "application/json"
}
}Search the web and return ranked results with titles, URLs, descriptions, and sources.
| Parameter | HTTP field | Type | Default | Description |
|---|---|---|---|---|
query |
query |
string | Required | Search query text, trimmed before sending, containing 1 to 1000 characters. |
country |
country |
string | "us" |
Two-letter country code to search from, sent in lowercase. |
numResults |
numResults |
number (integer) | 10 |
Number of search results to request, as an integer from 10 to 100. Fewer results may be returned. |
The HTTP deadline is fixed at 120 seconds. It is not a service parameter.
import { webSearch } from "@mrscraper/sdk";
const result = await webSearch("site:example.com documentation", {
country: "id",
numResults: 20,
});
console.log(result.data);The API body contains success, message, a data array, and tokenUsage. Each result includes rank, title, url, description, and source.
Success response
{
"status_code": 200,
"data": {
"success": true,
"message": "Example response",
"data": [
{
"rank": 1,
"title": "Example result",
"url": "https://example.com",
"description": "Example result description.",
"source": "example.com"
}
],
"tokenUsage": 1
},
"headers": {
"content-type": "application/json; charset=utf-8"
}
}Successful services use an envelope containing status_code, data, and headers. The data field contains the API response body; its field names are not converted to the SDK's naming style. Status preserves the complete body without adding summary fields.
{
"status_code": 200,
"data": "<html><body>Example page content...</body></html>",
"headers": {
"content-type": "text/html; charset=utf-8"
}
}Responses are MrScraperResponse<T> objects. JSON becomes JavaScript values, text remains string, and binary remains Buffer. Sensitive response headers are removed for status.
Authentication, HTTP, network, and timeout failures throw MrScraperError. Its status property is the HTTP status when available. Invalid arguments throw TypeError or RangeError before the request.
import { scrapeHtml, MrScraperError } from "@mrscraper/sdk";
try {
await scrapeHtml("https://example.com");
} catch (error) {
if (error instanceof MrScraperError)
console.error(error.status, error.message);
else throw error;
}Functions return promises and use camelCase options. Omit optional controls or use undefined; explicit false and 0 are preserved. TypeScript exports include PageOptions, HtmlOptions, MarkdownOptions, ScreenshotOptions, JsonOptions, WebSearchOptions, StatusOptions, and MrScraperResponse<T>.
Supply a generic response body type when you know the returned API shape:
import { scrapeJson } from "@mrscraper/sdk";
const result = await scrapeJson<{ data: { title: string } }>(
"https://example.com",
{ prompt: "Extract the page title" },
);
console.log(result.data.data.title);Save screenshot JSON as an image when the API returns a base64 screenshot:
import { getScreenshot } from "@mrscraper/sdk";
import { writeFile } from "node:fs/promises";
const result = await getScreenshot("https://example.com");
if (
typeof result.data === "object" &&
typeof result.data?.screenshot === "string"
) {
await writeFile("page.png", Buffer.from(result.data.screenshot, "base64"));
}Check environment credentials when authentication fails. Use camelCase option names and super, rather than old snake_case options or superMode. Page timeouts are integers from 1 to 300; status and search do not expose timeout options.
Replace account() with status() and read the raw API body. Remove status/search timeout options and rename superMode to super. Replace combined scraper calls with scrapeHtml, scrapeMarkdown, or getScreenshot; use camelCase options. Replace full_page with screenshot: "full" or "top". Search uses query, country, and numResults.
The automated suite checks service behavior without production API calls.
npm ci
npm test
npm run buildThe following commands call the live API using your credentials and consume quota.
npm run build
node file.js status
node file.js scrapeHtml https://example.com
node file.js webSearch "site:example.com documentation"MIT. See LICENSE.
