Pular para o conteúdo principal
POST
/
search
Pesquisar e, opcionalmente, raspar os resultados da busca
curl --request POST \
  --url https://api.firecrawl.dev/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 5,
  "tbs": "<string>",
  "location": "<string>",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {}
}
'
{
  "success": true,
  "data": [
    {
      "title": "<string>",
      "description": "<string>",
      "url": "<string>",
      "markdown": "<string>",
      "html": "<string>",
      "rawHtml": "<string>",
      "links": [
        "<string>"
      ],
      "screenshot": "<string>",
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "sourceURL": "<string>",
        "statusCode": 123,
        "error": "<string>"
      }
    }
  ],
  "warning": "<string>"
}
Observação: Uma nova versão v2 desta API está disponível, com recursos e desempenho aprimorados.
O endpoint /search combina a busca na web com os recursos de scraping do Firecrawl para retornar o conteúdo completo da página para qualquer consulta. Inclua scrapeOptions com formats: ["markdown"] para obter o conteúdo completo em Markdown para cada resultado de busca; caso contrário, por padrão você receberá apenas os resultados (url, title, description).

Operadores de consulta compatíveis

Oferecemos uma variedade de operadores de consulta que permitem filtrar melhor suas buscas.
OperadorFuncionalidadeExemplos
""Faz correspondência exata (não difusa) 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íficosite:firecrawl.dev
inurl:Retorna apenas resultados que incluem uma palavra na URLinurl:firecrawl
allinurl:Retorna apenas resultados que incluem várias palavras na URLallinurl:git firecrawl
intitle:Retorna apenas resultados que incluem uma palavra no título da páginaintitle:Firecrawl
allintitle:Retorna apenas resultados que incluem várias palavras no título da páginaallintitle:firecrawl playground
related:Retorna apenas resultados relacionados a um domínio específicorelated:firecrawl.dev

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 locais compatíveis para ver todos os países e idiomas disponíveis. Use o parâmetro tbs para filtrar os resultados por períodos, incluindo intervalos de datas personalizados. Consulte a documentação do recurso de busca para exemplos detalhados e formatos compatíveis.

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 pesquisa

limit
integer
padrão:5

Número máximo de resultados a retornar

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

Parâmetro de pesquisa baseado em tempo. Suporta períodos de tempo predefinidos (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y) e intervalos de datas personalizados (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY)

location
string

Parâmetro de localização para resultados de pesquisa

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 encaminhando dados da pesquisa para outros endpoints da API do Firecrawl.

scrapeOptions
object

Opções para extrair resultados de busca

Resposta

Resposta bem-sucedida

success
boolean
data
object[]
warning
string | null

Mensagem de aviso caso ocorra algum problema