POST
/
search
Search and optionally scrape search results
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": {
    "onlyMainContent": true,
    "includeTags": [
      "<string>"
    ],
    "excludeTags": [
      "<string>"
    ],
    "maxAge": 0,
    "headers": {},
    "waitFor": 0,
    "mobile": false,
    "skipTlsVerification": false,
    "timeout": 30000,
    "parsePDF": true,
    "jsonOptions": {
      "schema": {},
      "systemPrompt": "<string>",
      "prompt": "<string>"
    },
    "actions": [
      {
        "type": "wait",
        "milliseconds": 2,
        "selector": "#my-element"
      }
    ],
    "location": {
      "country": "US",
      "languages": [
        "en-US"
      ]
    },
    "removeBase64Images": true,
    "blockAds": true,
    "proxy": "basic",
    "storeInCache": true,
    "formats": []
  }
}'
{
  "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 (SERP) 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 do SERP (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.

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required

The search query

limit
integer
default:5

Maximum number of results to return

Required range: 1 <= x <= 100
tbs
string

Time-based search parameter. Supports predefined time ranges (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y) and custom date ranges (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY)

location
string

Location parameter for search results

timeout
integer
default:60000

Timeout in milliseconds

ignoreInvalidURLs
boolean
default:false

Excludes URLs from the search results that are invalid for other Firecrawl endpoints. This helps reduce errors if you are piping data from search into other Firecrawl API endpoints.

scrapeOptions
object

Options for scraping search results

Response

Successful response

success
boolean
data
object[]
warning
string | null

Warning message if any issues occurred