Pular para o conteúdo principal
POST
/
search
Pesquise e, opcionalmente, faça scraping dos resultados de busca
curl --request POST \
  --url https://api.firecrawl.dev/v2/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 5,
  "sources": [
    "web"
  ],
  "categories": [
    {
      "type": "github"
    }
  ],
  "tbs": "<string>",
  "location": "<string>",
  "country": "US",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {}
}
'
{
  "success": true,
  "data": {
    "web": [
      {
        "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>"
        }
      }
    ],
    "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>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ]
  },
  "warning": "<string>"
}

​
Novidades da v2

​
Pesquise em várias fontes

Pesquise na web, em imagens e em notícias ao mesmo tempo: 
{
  "query": "firecrawl web scraping",
  "sources": [ "web", "imagens", "notícias" ]
}

​
Formato da resposta modificado

v1: lista simples de resultados. v2: organizado por tipo de origem: 
{
  "success": true,
  "data": {
    "web": [/* resultados da web */],
    "images": [/* resultados de imagem */],
    "news": [/* resultados de notícias */]
  }
}

​
Novos recursos

  • Filtrar por intervalos de tempo (“última semana”, “último mês”)
  • Segmentar países/regiões específicas
  • Filtragem por categoria: pesquisar em repositórios do GitHub ou sites de pesquisa
  • Resultados limitados a 500 durante o alpha
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.
OperadorFuncionalidadeExemplos
""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íficosite:firecrawl.dev
inurl:Retorna apenas resultados que incluam uma palavra na URLinurl:firecrawl
allinurl:Retorna apenas resultados que incluam várias palavras na URLallinurl:git firecrawl
intitle:Retorna apenas resultados que incluam uma palavra no título da páginaintitle:Firecrawl
allintitle:Retorna apenas resultados que incluam várias palavras no título da páginaallintitle:firecrawl playground
related:Retorna apenas resultados relacionados a um domínio específicorelated:firecrawl.dev
imagesize:Retorna apenas imagens com dimensões exatasimagesize:1920x1080
larger:Retorna apenas imagens maiores que as dimensões especificadaslarger: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
}

​
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"
      }
    ]
  }
}
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.

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

​
limit
integer
padrão:5

Número máximo de resultados a retornar

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'].

​
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.

​
tbs
string

Parâmetro de pesquisa temporal. Suporta intervalos 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 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.

​
scrapeOptions
object

Opções para raspagem de resultados de busca

Resposta

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.

​
warning
string | null

Mensagem de aviso caso ocorra algum problema