FairCrawl Docs

Ship faster with the live FairCrawl surface

This docs site replaces the old one-page reference with a Starlight tree that mirrors how the product is actually used today:

• start with auth and quickstarts
• choose the right endpoint before you spend budget
• move between REST, SDKs, CLI, and MCP without switching concepts
• use the reference pages when you need the exact error or payload shape

One request, four runtimes

curl

```bash curl https://api.faircompany.ai/v1/crawl/web/scrape \ -X POST \ -H "Authorization: Bearer fc_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "url": "https://stripe.com/pricing", "format": "markdown", "only_main_content": true }' ```

TypeScript SDK

```ts import FairCrawl from "faircrawl"; const fc = new FairCrawl({ apiKey: process.env.FAIRCRAWL_API_KEY || "fc_live_xxx" }); const result = await fc.scrape({ url: "https://stripe.com/pricing", format: "markdown", only_main_content: true, }); console.log(result.text); console.log(result._meta.cost); ```

Python SDK

```python from faircrawl import FairCrawl fc = FairCrawl() result = fc.scrape( "https://stripe.com/pricing", format="markdown", only_main_content=True, ) print(result.text) print(result.meta.cost) ```

MCP

```json { "tool": "faircrawl_scrape", "arguments": { "url": "https://stripe.com/pricing", "format": "markdown", "only_main_content": true } } ```

Getting started

Introduction

Authentication

Rate limits

Pricing

Research

Use /research when the answer comes from multiple sources, not a single page. FairCrawl fans out across the live source set, deduplicates, ranks, optionally enriches top results with full-page reads, and can synthesize a grounded answer.

Research Overview

Sources

Scrape

Use /web/scrape for single-page extraction and /web/crawl for a bounded multi-page pass. Use /map before a deep crawl when you need URL discovery first.

Scrape

Crawl

Map

Enrich

Company enrichment is async-friendly and callback-aware. Freshness adds a second layer for tracking whether source data is due for re-fetching.

Company Enrichment

Freshness

Platforms

FairCrawl’s direct typed platform clients cover the live namespace wrappers in the TypeScript SDK. The platform pages in this docs site also show how to target research-only sources that currently live behind /research.

Platform Scrapers

SDKs + CLI