curl -X POST https://blazecrawl-dev.web.app/api/v1/scrape \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "format": "markdown"
  }'

{
  "success": true,
  "data": {
    "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...",
    "metadata": {
      "title": "Example Domain",
      "description": "Example Domain",
      "statusCode": 200,
      "url": "https://example.com"
    }
  }
}

Authorization: Bearer bc_live_xxxxxxxxxxxxxxxx

curl -X POST https://blazecrawl-dev.web.app/api/v1/scrape \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://docs.example.com/getting-started",
    "format": "markdown",
    "excludeTags": ["nav", "footer", ".sidebar"],
    "waitFor": 2000
  }'

{
  "success": true,
  "data": {
    "markdown": "# Getting Started\n\nWelcome to the documentation...",
    "html": "<h1>Getting Started</h1><p>Welcome to the documentation...</p>",
    "metadata": {
      "title": "Getting Started - Example Docs",
      "description": "Learn how to get started with Example.",
      "language": "en",
      "statusCode": 200,
      "url": "https://docs.example.com/getting-started"
    }
  }
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/crawl \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://docs.example.com",
    "maxPages": 500,
    "maxDepth": 5,
    "includePaths": ["/docs/*", "/guides/*"],
    "excludePaths": ["/blog/*"],
    "format": "markdown"
  }'

{
  "success": true,
  "id": "crawl_abc123xyz",
  "url": "https://blazecrawl-dev.web.app/api/v1/crawl/crawl_abc123xyz"
}

curl https://blazecrawl-dev.web.app/api/v1/crawl/crawl_abc123xyz \
  -H "Authorization: Bearer bc_live_xxx"

{
  "success": true,
  "status": "crawling",
  "pagesFound": 142,
  "pagesCrawled": 87,
  "data": [
    {
      "url": "https://docs.example.com/intro",
      "markdown": "# Introduction\n\n...",
      "metadata": { "title": "Introduction", "statusCode": 200 }
    }
  ]
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/map \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "maxUrls": 500,
    "includePaths": ["/docs/*"]
  }'

{
  "success": true,
  "count": 47,
  "urls": [
    "https://example.com/docs",
    "https://example.com/docs/getting-started",
    "https://example.com/docs/authentication",
    "https://example.com/docs/api-reference",
    "https://example.com/docs/sdks/python",
    "https://example.com/docs/sdks/node"
  ]
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/extract \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://store.example.com/product/wireless-headphones",
    "schema": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "price": { "type": "number" },
        "currency": { "type": "string" },
        "rating": { "type": "number" },
        "reviewCount": { "type": "integer" },
        "inStock": { "type": "boolean" },
        "features": {
          "type": "array",
          "items": { "type": "string" }
        }
      }
    },
    "prompt": "Extract the main product details from this page."
  }'

{
  "success": true,
  "data": {
    "name": "ProSound Wireless Headphones X3",
    "price": 149.99,
    "currency": "USD",
    "rating": 4.7,
    "reviewCount": 2847,
    "inStock": true,
    "features": [
      "Active noise cancellation",
      "40-hour battery life",
      "Bluetooth 5.3",
      "Multi-device pairing",
      "Foldable design"
    ]
  }
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/search \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "best practices for web scraping 2026",
    "limit": 3,
    "format": "markdown",
    "country": "us",
    "lang": "en"
  }'

{
  "success": true,
  "data": {
    "query": "best practices for web scraping 2026",
    "results": [
      {
        "url": "https://example.com/web-scraping-guide",
        "title": "Web Scraping Best Practices in 2026",
        "description": "A comprehensive guide to ethical and efficient web scraping...",
        "markdown": "# Web Scraping Best Practices\n\nIn 2026, the landscape of web scraping...",
        "metadata": {
          "statusCode": 200,
          "language": "en"
        }
      }
    ]
  }
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/interact \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/search",
    "actions": [
      { "type": "type", "selector": "input[name=q]", "value": "BlazeCrawl" },
      { "type": "press", "key": "Enter" },
      { "type": "wait", "milliseconds": 2000 },
      { "type": "screenshot" }
    ],
    "format": "markdown"
  }'

{
  "success": true,
  "data": {
    "url": "https://example.com/search?q=BlazeCrawl",
    "content": "# Search Results\n\n1. BlazeCrawl - Turn websites into LLM-ready data...",
    "format": "markdown",
    "screenshots": [
      "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
    ]
  }
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/batch/scrape \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/page-1",
      "https://example.com/page-2",
      "https://example.com/page-3"
    ],
    "format": "markdown",
    "webhook": "https://your-server.com/webhook/batch-complete"
  }'

{
  "success": true,
  "data": {
    "batchId": "batch_abc123xyz",
    "status": "processing",
    "totalUrls": 3
  }
}

curl https://blazecrawl-dev.web.app/api/v1/batch/scrape/batch_abc123xyz \
  -H "Authorization: Bearer bc_live_xxx"

{
  "success": true,
  "data": {
    "batchId": "batch_abc123xyz",
    "status": "completed",
    "totalUrls": 3,
    "completedUrls": 3,
    "results": [
      {
        "url": "https://example.com/page-1",
        "markdown": "# Page 1\n\nContent...",
        "metadata": { "title": "Page 1", "statusCode": 200 }
      }
    ]
  }
}

curl -X POST https://blazecrawl-dev.web.app/api/v1/agent \
  -H "Authorization: Bearer bc_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Find the pricing pages for the top 3 web scraping APIs and compare their free tier limits",
    "maxSteps": 20,
    "maxUrls": 10
  }'

{
  "success": true,
  "data": {
    "jobId": "agent_abc123xyz",
    "status": "running"
  }
}

curl https://blazecrawl-dev.web.app/api/v1/agent/agent_abc123xyz \
  -H "Authorization: Bearer bc_live_xxx"

{
  "success": true,
  "data": {
    "jobId": "agent_abc123xyz",
    "status": "completed",
    "stepsUsed": 12,
    "urlsVisited": 6,
    "result": "## Web Scraping API Pricing Comparison\n\n| Provider | Free Tier | Rate Limit |\n|---|---|---|\n| BlazeCrawl | 500 credits/mo | 2 concurrent |\n| ...",
    "sources": [
      "https://blazecrawl.dev/pricing",
      "https://competitor1.com/pricing",
      "https://competitor2.com/pricing"
    ]
  }
}

import BlazeCrawl from "blazecrawl";

const client = new BlazeCrawl({ apiKey: "bc_live_xxx" });

// Scrape a single page
const result = await client.scrape({
  url: "https://example.com",
  format: "markdown",
});
console.log(result.markdown);

// Crawl an entire site
const crawl = await client.crawl({
  url: "https://docs.example.com",
  maxPages: 100,
  format: "markdown",
});
for (const page of crawl.data) {
  console.log(`${page.url}: ${page.markdown.length} chars`);
}

// Search the web
const search = await client.search({
  query: "web scraping best practices",
  limit: 5,
});
for (const r of search.results) {
  console.log(`${r.title}: ${r.url}`);
}

from blazecrawl import BlazeCrawl

client = BlazeCrawl(api_key="bc_live_xxx")

# Scrape a single page
result = client.scrape(
    url="https://example.com",
    format="markdown"
)
print(result.markdown)

# Crawl an entire site
crawl = client.crawl(
    url="https://docs.example.com",
    max_pages=100,
    format="markdown"
)
for page in crawl.data:
    print(f"{page.url}: {len(page.markdown)} chars")

# Extract structured data
product = client.extract(
    url="https://store.example.com/product/1",
    schema={
        "type": "object",
        "properties": {
            "name": {"type": "string"},
            "price": {"type": "number"}
        }
    }
)
print(f"{product.data['name']}: ${product.data['price']}")

# Install globally
npm install -g blazecrawl-cli

# Authenticate
blazecrawl auth set bc_live_xxx

# Scrape a URL
blazecrawl scrape https://example.com --format markdown

# Crawl a site
blazecrawl crawl https://docs.example.com --max-pages 50

# Search the web
blazecrawl search "web scraping tutorials" --limit 5

# Install the MCP server
npm install blazecrawl-mcp

# Run as a Model Context Protocol server
npx blazecrawl-mcp --api-key bc_live_xxx

# Add to your Claude Desktop / AI agent config:
# {
#   "mcpServers": {
#     "blazecrawl": {
#       "command": "npx",
#       "args": ["blazecrawl-mcp", "--api-key", "bc_live_xxx"]
#     }
#   }
# }

from langchain_blazecrawl import BlazeCrawlLoader

loader = BlazeCrawlLoader(
    api_key="bc_live_xxx",
    url="https://docs.example.com",
    mode="crawl",
    params={"max_pages": 50, "format": "markdown"}
)
documents = loader.load()

# Use with any LangChain chain or retriever
for doc in documents:
    print(f"{doc.metadata['url']}: {len(doc.page_content)} chars")

from llama_index_blazecrawl import BlazeCrawlReader

reader = BlazeCrawlReader(api_key="bc_live_xxx")

# Load documents from a website
documents = reader.load_data(
    url="https://docs.example.com",
    max_pages=50
)

# Build an index
from llama_index.core import VectorStoreIndex
index = VectorStoreIndex.from_documents(documents)
query_engine = index.as_query_engine()
response = query_engine.query("How do I authenticate?")

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1711500000
Retry-After: 12

{
  "success": false,
  "error": {
    "code": "INVALID_URL",
    "message": "The provided URL is not valid or not reachable.",
    "statusCode": 422
  }
}