API reference

Web Page to Markdown API

Fetch a public web page and return its content as markdown, text, raw HTML, links, and/or page metadata. Fetch modes: direct by default; browser, enhanced and rendered are deployment-gated and off by default. Requested output shapes are unchanged. An unavailable non-direct mode returns 424 rather than silently ignoring the requested mode.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/web/scrapelive · proven1 credit

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`url`	yes	Page URL to scrape (http/https, public hosts only)	`https://example.com`
`formats`	no	Comma-separated subset of markdown,html,text,links,metadata (default markdown,metadata)	`markdown,metadata`
`only_main_content`	no	Strip page chrome (nav/header/footer/aside) and return the main content region (default true)	`true`
`timeout`	no	Fetch budget in milliseconds, clamped to 1000-15000	`10000`
`fetch_mode`	no	Fetch mode: direct (default) reads static HTML; browser explicitly runs JavaScript in an owned, isolated browser. Enhanced and rendered try direct first and permit configured fallbacks. Non-direct modes require deployment enablement, an approved target and applicable resource or spending limits; otherwise the request is refused. Output formats are unchanged.	`direct`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/web/scrape?url=https%3A%2F%2Fexample.com" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/web/scrape?url=https%3A%2F%2Fexample.com",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/web/scrape?url=https%3A%2F%2Fexample.com",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "web",
  "endpoint": "/v1/web/scrape",
  "data": {
    "_warnings": [
      "example"
    ],
    "content_strategy": "example",
    "content_type": "example",
    "description": "example",
    "final_url": "https://example.com/example",
    "language": "example",
    "markdown": "example",
    "only_main_content": false,
    "status": 0,
    "title": "example",
    "url": "https://example.com/example"
  },
  "credits_used": 1,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`_warnings`	`array \| null`	Optional warnings supplied by this operation. Null means unknown.
`content_strategy`	`string \| null`	Optional content strategy supplied by this operation. Null means unknown.
`content_type`	`string \| null`	Optional content type supplied by this operation. Null means unknown.
`description`	`string \| null`	Source description; null or absent means not supplied.
`final_url`	`string \| null`	Optional final url supplied by this operation. Null means unknown.
`language`	`string \| null`	Optional language supplied by this operation. Null means unknown.
`markdown`	`string \| null`	Optional markdown supplied by this operation. Null means unknown.
`only_main_content`	`boolean \| null`	Optional only main content supplied by this operation. Null means unknown.
`status`	`number \| null`	Optional status supplied by this operation. Null means unknown.
`title`	`string \| null`	Source title when supplied.
`url`	`string \| null`	Original source URL when supplied.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Web Page to Markdown API

Query parameters

Make the request

Response fields and example

More Web Scraping reference

First call in under a minute