Início rápido

Bem-vindo ao Firecrawl

O Firecrawl é um serviço de API que recebe uma URL, a rastreia e a converte em Markdown limpo. Rastreamos todas as subpáginas acessíveis e entregamos Markdown limpo para cada uma. Não é necessário sitemap.

Como usar?

Fornecemos uma API fácil de usar com nossa versão hospedada. Você pode acessar o playground e a documentação aqui. Você também pode hospedar o backend por conta própria, se preferir. Confira os seguintes recursos para começar:

API: Documentação
SDKs: Python, Node, Go, Rust
Frameworks de LLM: Langchain (Python), Langchain (JS), Llama Index, Crew.ai, Composio, PraisonAI, Superinterface, Vectorize
Frameworks low-code: Dify, Langflow, Flowise AI, Cargo, Pipedream
Outros: Zapier, Pabbly Connect
Quer um SDK ou integração? Avise-nos abrindo uma issue.

Self-host: Para hospedar por conta própria, consulte o guia aqui.

Chave de API

Para usar a API, você precisa se inscrever no Firecrawl e obter uma chave de API.

Rastreamento

Usado para rastrear uma URL e todas as subpáginas acessíveis. Isso envia uma tarefa de rastreamento e retorna um ID da tarefa para verificar o status do rastreamento.

Instalação

pip install firecrawl-py

npm install firecrawl

go get github.com/mendableai/firecrawl-go

# adicione o seguinte ao seu Cargo.toml

[dependencies]
firecrawl = "^0.1"
tokio = { version = "^1", features = ["full"] }
serde = { version = "^1.0", features = ["derive"] }
serde_json = "^1.0"
uuid = { version = "^1.10", features = ["v4"] }

[build-dependencies]
tokio = { version = "1", features = ["full"] }

Uso

from firecrawl import Firecrawl

app = Firecrawl(api_key="YOUR_API_KEY")

crawl_result = app.crawl_url('docs.firecrawl.dev', {'crawlerOptions': {'excludes': ['blog/*']}})

# Obter o markdown
for result in crawl_result:
    print(result['markdown'])

import { Firecrawl } from "firecrawl";

// Inicialize o Firecrawl com sua chave de API
const app = new Firecrawl({ apiKey: "YOUR_API_KEY" });

// Rastreiar um site
const crawlResult = await app.crawlUrl("docs.firecrawl.dev", {
  crawlerOptions: { excludes: ["blog/*"] },
});

// Exibir o markdown no console
console.log(crawlResult.map((result) => result.markdown));

import (
  "fmt"
  "log"

  "github.com/mendableai/firecrawl-go"
)

func main() {
  // Inicialize o Firecrawl com sua chave de API
  app, err := firecrawl.NewFirecrawlApp("YOUR_API_KEY")
  if err != nil {
    log.Fatalf("Falha ao inicializar o Firecrawl: %v", err)
  }

  // Rastrear um site
  params := map[string]any{
    "crawlerOptions": map[string]any{
      "excludes": []string{"blog/*"},
    },
  }
  crawlResult, err := app.CrawlURL("docs.firecrawl.dev", params)
  if err != nil {
    log.Fatalf("Ocorreu um erro durante o rastreamento: %v", err)
  }

  // Obter o markdown
  for _, result := range crawlResult {
    fmt.Println(result.Markdown)
  }
}

use firecrawl::Firecrawl;

#[tokio::main]
async fn main() {
  // Inicialize o Firecrawl com a chave de API
  let api_key = "YOUR_API_KEY";
  let api_url = "https://api.firecrawl.dev";
  let app = Firecrawl::new(api_key, api_url).expect("Failed to initialize Firecrawl");

  // Rastrear a URL
  let crawl_params = json!({
    "crawlerOptions": {
        "excludes": ["blog/*"]
    }
  });

  let crawl_result = app
      .crawl_url("https://example.com", Some(crawl_params), true, 2, None)
      .await;

  // Imprimir o resultado do rastreamento
  match crawl_result {
      Ok(data) => println!("Resultado do rastreamento:\n{}", data),
      Err(e) => eprintln!("Falha no rastreamento: {}", e),
  }
}

curl -X POST https://api.firecrawl.dev/v0/crawl \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev"
    }'

Se você não estiver usando o SDK ou preferir usar webhook ou outro método de polling, defina wait_until_done como false. Isso retornará um jobId. No cURL, /crawl sempre retornará um jobId que você pode usar para verificar o status do rastreamento.

{ "jobId": "1234-5678-9101" }

Verificar status do crawl

Usado para checar o status de um job de crawl e obter seu resultado.

status = app.check_crawl_status(job_id)

const status = await app.checkCrawlStatus(jobId);

status, err := app.CheckCrawlStatus(jobId)
if err != nil {
  log.Fatalf("Failed to check crawl status: %v", err)
}

let status = match app.check_crawl_status(jobId).await {
    Ok(status) => status,
    Err(e) => panic!("Failed to check crawl status: {:?}", e),
};

println!("Crawl Status: {:?}", status);

curl -X GET https://api.firecrawl.dev/v0/crawl/status/1234-5678-9101 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Resposta

{
  "status": "concluído",
  "current": 22,
  "total": 22,
  "data": [
    {
      "content": "Conteúdo bruto ",
      "markdown": "# Conteúdo em Markdown",
      "provider": "web-scraper",
      "metadata": {
        "title": "Firecrawl | Raspagem confiável da web para seus LLMs",
        "description": "IA para CX e Vendas"
        "language": null,
        "sourceURL": "https://docs.firecrawl.dev/"
      }
    }
  ]
}

Scraping

Para extrair dados de uma única URL, use o método scrape_url. Ele recebe a URL como parâmetro e retorna os dados coletados como um dicionário.

from firecrawl import Firecrawl

app = Firecrawl(api_key="YOUR_API_KEY")

content = app.scrape_url("https://docs.firecrawl.dev")

import { Firecrawl } from 'firecrawl-js';

const app = new Firecrawl({ apiKey: 'YOUR_API_KEY' });

const content = await app.scrapeUrl('https://docs.firecrawl.dev');

import (
  "log"

  "github.com/mendableai/firecrawl-go"
)

func main() {
  app, err := firecrawl.NewFirecrawlApp("YOUR_API_KEY")
  if err != nil {
    log.Fatalf("Failed to initialize Firecrawl: %v", err)
  }

  content, err := app.ScrapeURL("docs.firecrawl.dev", nil)
  if err != nil {
    log.Fatalf("Failed to scrape URL: %v", err)
  }
}

use firecrawl::Firecrawl;

#[tokio::main]
async fn main() {
    // Inicialize o Firecrawl com a chave de API
    let api_key = "YOUR_API_KEY";
    let api_url = "https://api.firecrawl.dev";
    let app = Firecrawl::new(api_key, api_url).expect("Failed to initialize Firecrawl");

    // Faça o scraping da URL
    let scrape_result = app.scrape_url("https://example.com", None).await;

    // Imprima o resultado do scraping
  match scrape_result {
    Ok(data) => println!("Scrape Result:\n{}", data["markdown"]),
    Err(e) => eprintln!("Scrape failed: {}", e),
  }
}

curl -X POST https://api.firecrawl.dev/v0/scrape \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev"
    }'

Resposta

{
  "success": true,
  "data": {
    "markdown": "<string>",
    "content": "<string>",
    "html": "<string>",
    "rawHtml": "<string>",
    "metadata": {
      "title": "<string>",
      "description": "<string>",
      "language": "<string>",
      "sourceURL": "<string>",
      "<outros metadados>": "<string>",
      "pageStatusCode": 123,
      "pageError": "<string>"
    },
    "llm_extraction": {},
    "warning": "<string>"
  }
}

Extração

Com a extração via LLM, você pode extrair facilmente dados estruturados de qualquer URL. Oferecemos suporte a schemas Pydantic para facilitar seu uso. Veja como utilizá-la:

class ArticleSchema(BaseModel):
    title: str
    points: int 
    by: str
    commentsURL: str

class TopArticlesSchema(BaseModel):
top: List[ArticleSchema] = Field(..., max_items=5, description="Top 5 stories")

data = app.scrape_url('https://news.ycombinator.com', {
'extractorOptions': {
'extractionSchema': TopArticlesSchema.model_json_schema(),
'mode': 'llm-extraction'
},
'pageOptions':{
'onlyMainContent': True
}
})
print(data["llm_extraction"])

import { Firecrawl } from "firecrawl";
import { z } from "zod";

const app = new Firecrawl({
  apiKey: "fc-YOUR_API_KEY",
});

// Defina o schema para extrair o conteúdo
const schema = z.object({
  top: z
    .array(
      z.object({
        title: z.string(),
        points: z.number(),
        by: z.string(),
        commentsURL: z.string(),
      })
    )
    .length(5)
    .describe("Top 5 stories on Hacker News"),
});

const scrapeResult = await app.scrapeUrl("https://news.ycombinator.com", {
  extractorOptions: { extractionSchema: schema },
});

console.log(scrapeResult.data["llm_extraction"]);

import (
  "fmt"
  "log"

  "github.com/mendableai/firecrawl-go"
)

app, err := NewFirecrawlApp(TEST_API_KEY, API_URL)
if err != nil {
  log.Fatalf("Falha ao inicializar o Firecrawl: %v", err)
}

params := map[string]any{
  "extractorOptions": ExtractorOptions{
    Mode:             "llm-extraction",
    ExtractionPrompt: "Based on the information on the page, find what the company's mission is and whether it supports SSO, and whether it is open source",
    ExtractionSchema: map[string]any{
      "type": "object",
      "properties": map[string]any{
        "company_mission": map[string]string{"type": "string"},
        "supports_sso":    map[string]string{"type": "boolean"},
        "is_open_source":  map[string]string{"type": "boolean"},
      },
      "required": []string{"company_mission", "supports_sso", "is_open_source"},
    },
  },
}

scrapeResult, err := app.ScrapeURL("https://news.ycombinator.com", params)
if err != nil {
  log.Fatalf("Falha ao fazer o scrape da URL: %v", err)
}
fmt.Println(scrapeResult.LLMExtraction)

use firecrawl::Firecrawl;

#[tokio::main]
async fn main() {
    // Inicialize o Firecrawl com a chave da API
    let api_key = "YOUR_API_KEY";
    let api_url = "https://api.firecrawl.dev";
    let app = Firecrawl::new(api_key, api_url).expect("Failed to initialize Firecrawl");

    // Defina o schema para extrair o conteúdo
    let json_schema = json!({
        "type": "object",
        "properties": {
            "top": {
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": {
                        "title": {"type": "string"},
                        "points": {"type": "number"},
                        "by": {"type": "string"},
                        "commentsURL": {"type": "string"}
                    },
                    "required": ["title", "points", "by", "commentsURL"]
                },
                "minItems": 5,
                "maxItems": 5,
                "description": "Top 5 stories on Hacker News"
            }
        },
        "required": ["top"]
    });

    let llm_extraction_params = json!({
        "extractorOptions": {
            "extractionSchema": json_schema,
            "mode": "llm-extraction"
        },
        "pageOptions": {
            "onlyMainContent": true
        }
    });

    let llm_extraction_result = app
        .scrape_url("https://news.ycombinator.com", Some(llm_extraction_params))
        .await;
    match llm_extraction_result {
        Ok(data) => println!("Resultado da extração por LLM:\n{}", data["llm_extraction"]),
        Err(e) => eprintln!("Falha na extração por LLM: {}", e),
    }
}

curl -X POST https://api.firecrawl.dev/v0/scrape \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev/",
      "extractorOptions": {
        "mode": "llm-extraction",
        "extractionPrompt": "Based on the information on the page, extract the information from the schema. ",
        "extractionSchema": {
          "type": "object",
          "properties": {
            "company_mission": {
                      "type": "string"
            },
            "supports_sso": {
                      "type": "boolean"
            },
            "is_open_source": {
                      "type": "boolean"
            },
            "is_in_yc": {
                      "type": "boolean"
            }
          },
          "required": [
            "company_mission",
            "supports_sso",
            "is_open_source",
            "is_in_yc"
          ]
        }
      }
    }'

Contribuindo

Adoramos contribuições! Leia nosso guia de contribuição antes de enviar um pull request.

Get Started

Core Endpoints

More

Quickstarts

Developer Guides

Webhooks

Use Cases

Other

Contributing

Bem-vindo ao Firecrawl

Como usar?

Chave de API

Rastreamento

Instalação

Uso

Verificar status do crawl

Resposta

Scraping

Resposta

Extração

Contribuindo

​Bem-vindo ao Firecrawl

​Como usar?

​Chave de API

​Rastreamento

​Instalação

​Uso

​Verificar status do crawl

​Resposta

​Scraping

​Resposta

​Extração

​Contribuindo

Bem-vindo ao Firecrawl

Como usar?

Chave de API

Rastreamento

Instalação

Uso

Verificar status do crawl

Resposta

Scraping

Resposta

Extração

Contribuindo