Pesquisa

POST /search

Pesquise e, opcionalmente, faça scraping dos resultados de busca

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 10,
  "sources": [
    "web"
  ],
  "categories": [
    {
      "type": "github"
    }
  ],
  "includeDomains": [
    "<string>"
  ],
  "excludeDomains": [
    "<string>"
  ],
  "tbs": "<string>",
  "location": "<string>",
  "country": "US",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "enterprise": [
    "anon"
  ],
  "scrapeOptions": {}
}
'

200

{
  "success": true,
  "data": {
    "web": [
      {
        "title": "<string>",
        "description": "<string>",
        "url": "<string>",
        "markdown": "<string>",
        "html": "<string>",
        "rawHtml": "<string>",
        "links": [
          "<string>"
        ],
        "screenshot": "<string>",
        "audio": "<string>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "url": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ],
    "images": [
      {
        "title": "<string>",
        "imageUrl": "<string>",
        "imageWidth": 123,
        "imageHeight": 123,
        "url": "<string>",
        "position": 123
      }
    ],
    "news": [
      {
        "title": "<string>",
        "snippet": "<string>",
        "url": "<string>",
        "date": "<string>",
        "imageUrl": "<string>",
        "position": 123,
        "markdown": "<string>",
        "html": "<string>",
        "rawHtml": "<string>",
        "links": [
          "<string>"
        ],
        "screenshot": "<string>",
        "audio": "<string>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "url": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ]
  },
  "warning": "<string>",
  "id": "<string>",
  "creditsUsed": 123
}

O endpoint de pesquisa combina pesquisa na web com as capacidades de scraping do Firecrawl para retornar o conteúdo completo da página para qualquer consulta.

Inclua scrapeOptions com formats: [{"type": "markdown"}] para obter o conteúdo completo em markdown para cada resultado de pesquisa; caso contrário, você receberá por padrão apenas os resultados (url, title, description). Você também pode usar outros formatos, como {"type": "summary"} para conteúdo condensado.

​

Operadores de pesquisa compatíveis

Oferecemos uma variedade de operadores de pesquisa que ajudam você a filtrar melhor seus resultados.

Operador	Funcionalidade	Exemplos
""	Faz uma correspondência exata com um trecho de texto	"Firecrawl"
-	Exclui determinadas palavras-chave ou nega outros operadores	-bad, -site:firecrawl.dev
site:	Retorna apenas resultados de um site específico	site:firecrawl.dev
filetype:	Retorna apenas resultados com uma extensão de arquivo específica	filetype:pdf, -filetype:pdf
inurl:	Retorna apenas resultados que incluam uma palavra na URL	inurl:firecrawl
allinurl:	Retorna apenas resultados que incluam várias palavras na URL	allinurl:git firecrawl
intitle:	Retorna apenas resultados que incluam uma palavra no título da página	intitle:Firecrawl
allintitle:	Retorna apenas resultados que incluam várias palavras no título da página	allintitle:firecrawl playground
related:	Retorna apenas resultados relacionados a um domínio específico	related:firecrawl.dev
imagesize:	Retorna apenas imagens com dimensões exatas	imagesize:1920x1080
larger:	Retorna apenas imagens maiores que as dimensões especificadas	larger:1920x1080

​

Parâmetro de localização

Use o parâmetro location para obter resultados de pesquisa segmentados por região. Formato: "string". Exemplos: "Germany", "San Francisco,California,United States".

Consulte a lista completa de localidades compatíveis para ver todos os países e idiomas disponíveis.

​

Parâmetro country

Use o parâmetro country para definir o país dos resultados de pesquisa usando códigos de país ISO. Padrão: "US".

Exemplos: "US", "DE", "FR", "JP", "UK", "CA".

{
  "query": "restaurantes",
  "country": "DE"
}

​

Parâmetro categories

Filtre os resultados de pesquisa por categorias específicas usando o parâmetro categories:

• github: Pesquise em repositórios do GitHub, código, issues e documentação
• research: Pesquise em sites acadêmicos e de pesquisa (arXiv, Nature, IEEE, PubMed, etc.)
• pdf: Pesquise por PDFs

​

Exemplo de uso

{
  "query": "machine learning",
  "categories": ["github", "pesquisa"],
  "limit": 10
}

​

Filtros de domínio

Use includeDomains para restringir os resultados a domínios específicos ou excludeDomains para excluir domínios específicos da busca. Os domínios devem conter apenas nomes de host, sem protocolo ou caminho.

includeDomains e excludeDomains são mutuamente excludentes.

​

Exemplo de inclusão de domínios

{
  "query": "web scraping",
  "includeDomains": ["firecrawl.dev", "docs.firecrawl.dev"],
  "limit": 10
}

​

Exemplo de exclusão de domínios

{
  "query": "web scraping tools",
  "excludeDomains": ["example.com"],
  "limit": 10
}

​

Categoria da Resposta

Cada resultado inclui um campo category que indica sua origem:

{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://github.com/example/ml-project",
        "title": "Machine Learning Project",
        "description": "Implementation of ML algorithms",
        "category": "github"
      },
      {
        "url": "https://arxiv.org/abs/2024.12345",
        "title": "ML Research Paper",
        "description": "Latest advances in machine learning",
        "category": "research"
      }
    ]
  }
}

​

Busca por período de tempo

Use o parâmetro tbs para filtrar resultados por períodos de tempo, incluindo intervalos de datas personalizados. Consulte a documentação do recurso de busca para exemplos detalhados e formatos suportados.

Você é um agente de IA que precisa de uma chave de API da Firecrawl? Consulte firecrawl.dev/agent-onboarding/SKILL.md para instruções de onboarding automatizado.

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json

query · string · obrigatório

A consulta de busca

Maximum string length: 500

limit · integer · padrão: 10

Número máximo de resultados retornados (por tipo de fonte ao usar várias fontes)

Intervalo obrigatório: 1 <= x <= 100

sources · (Web · object | Images · object | News · object)[]

Fontes a serem pesquisadas. Determina os arrays disponíveis na resposta. O padrão é ['web'].

Web

Images

News

Show child attributes

categories · (GitHub · object | Research · object | PDF · object)[]

Categorias pelas quais filtrar os resultados. O padrão é [], o que significa que os resultados não serão filtrados por nenhuma categoria.

GitHub

Research

PDF

Show child attributes

includeDomains · string<hostname>[]

Restringe os resultados de busca aos domínios especificados. Os domínios devem ser apenas nomes de host, sem protocolo nem caminho. Não pode ser usado com excludeDomains.

excludeDomains · string<hostname>[]

Exclui os resultados de busca dos domínios especificados. Os domínios devem ser apenas nomes de host, sem protocolo nem caminho. Não pode ser usado com includeDomains.

tbs · string

Parâmetro de pesquisa por tempo. Suporta intervalos de tempo predefinidos (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y), intervalos de datas personalizados (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY) e classificação por data (sbd:1). Os valores podem ser combinados, por exemplo: sbd:1,qdr:w.

location · string

Parâmetro de localização para resultados de busca (por exemplo, San Francisco,California,United States). Para melhores resultados, defina tanto este quanto o parâmetro country.

country · string · padrão: US

Código de país ISO para segmentação geográfica dos resultados de pesquisa (por exemplo, US). Para obter melhores resultados, configure este parâmetro e também o parâmetro location.

timeout · integer · padrão: 60000

Tempo limite em milissegundos

ignoreInvalidURLs · boolean · padrão: false

Exclui dos resultados de pesquisa as URLs que são inválidas para outros endpoints do Firecrawl. Isso ajuda a reduzir erros se você estiver direcionando dados da pesquisa para outros endpoints da API do Firecrawl.

enterprise · enum<string>[]

Opções de busca Enterprise para Zero Data Retention (ZDR). Use ["zdr"] para ZDR de ponta a ponta (10 credits / 10 resultados) ou ["anon"] para ZDR anonimizado (2 credits / 10 resultados). Deve estar habilitado para a sua equipe.

Opções disponíveis: anon, zdr

scrapeOptions · object

Opções para raspagem de resultados de busca

Show child attributes

Resposta

200

application/json

Resposta bem-sucedida

success · boolean

data · object

Os resultados da pesquisa. Os arrays disponíveis dependerão das fontes que você especificar na requisição. Por padrão, o array web será retornado.

Show child attributes

warning · string | null

Mensagem de aviso caso ocorra algum problema

id · string

O ID da tarefa de pesquisa

creditsUsed · integer

O número de créditos utilizados na busca