Saltar al contenido principal
POST
/
search
Buscar y, opcionalmente, scrapear los resultados de búsqueda
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>"
}

Novedades de la v2

Buscar en varias fuentes

Busca en la web, imágenes y noticias al mismo tiempo:
{
  "query": "firecrawl web scraping",
  "sources": [ "web", "imágenes", "noticias" ]
}

Formato de la respuesta actualizado

v1: lista simple de resultados. v2: resultados organizados por tipo de origen:
{
  "success": true,
  "data": {
    "web": [/* web results */],
    "images": [/* resultados de imágenes */],
    "news": [/* news results */]
  }
}

Nuevas funcionalidades

  • Filtrado por rangos de tiempo (“última semana”, “último mes”)
  • Segmentación por países/regiones específicos
  • Filtrado por categoría: búsqueda dentro de repositorios de GitHub o sitios web de investigación
  • Resultados limitados a 500 durante la fase alfa
El endpoint de búsqueda combina la búsqueda web con las capacidades de scraping de Firecrawl para devolver el contenido completo de la página para cualquier consulta. Incluye scrapeOptions con formats: [{"type": "markdown"}] para obtener el contenido completo en markdown de cada resultado de búsqueda; de lo contrario, por defecto solo obtendrás los resultados (url, title, description). También puedes usar otros formatos como {"type": "summary"} para obtener contenido condensado.

Operadores de consulta admitidos

Admitimos una variedad de operadores de consulta que te permiten filtrar mejor tus búsquedas.
OperadorFuncionalidadEjemplos
""Coincidencia exacta de una cadena de texto (no difusa)"Firecrawl"
-Excluye ciertas palabras clave o niega otros operadores-bad, -site:firecrawl.dev
site:Devuelve solo resultados de un sitio web específicosite:firecrawl.dev
inurl:Devuelve solo resultados que incluyan una palabra en la URLinurl:firecrawl
allinurl:Devuelve solo resultados que incluyan varias palabras en la URLallinurl:git firecrawl
intitle:Devuelve solo resultados que incluyan una palabra en el título de la páginaintitle:Firecrawl
allintitle:Devuelve solo resultados que incluyan varias palabras en el título de la páginaallintitle:firecrawl playground
related:Devuelve solo resultados relacionados con un dominio específicorelated:firecrawl.dev
imagesize:Devuelve solo imágenes con dimensiones exactasimagesize:1920x1080
larger:Devuelve solo imágenes más grandes que las dimensiones especificadaslarger:1920x1080

Parámetro de ubicación

Usa el parámetro location para obtener resultados de búsqueda geodirigidos. Formato: "string". Ejemplos: "Germany", "San Francisco,California,United States". Consulta la lista completa de ubicaciones compatibles para ver todos los países e idiomas disponibles.

Parámetro country

Usa el parámetro country para especificar el país de los resultados de búsqueda usando códigos de país ISO. Valor predeterminado: "US". Ejemplos: "US", "DE", "FR", "JP", "UK", "CA".
{
  "query": "restaurantes",
  "country": "DE"
}

Parámetro categories

Filtra los resultados de búsqueda por categorías específicas usando el parámetro categories:
  • github: Busca en repositorios de GitHub, código, issues y documentación
  • research: Busca en sitios web académicos y de investigación (arXiv, Nature, IEEE, PubMed, etc.)
  • pdf: Busca archivos PDF

Ejemplo de uso

{
  "query": "aprendizaje automático",
  "categories": ["github", "investigación"],
  "limit": 10
}

Respuesta de categoría

Cada resultado incluye un campo category que indica su origen:
{
  "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"
      }
    ]
  }
}
Usa el parámetro tbs para filtrar los resultados por períodos de tiempo, incluidos rangos de fechas personalizados. Consulta la documentación de la funcionalidad de búsqueda para ver ejemplos detallados y formatos compatibles.

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
query
string
requerido

Consulta de búsqueda

limit
integer
predeterminado:5

Número máximo de resultados que se devolverán

Rango requerido: 1 <= x <= 100
sources
(Web · object | Images · object | News · object)[]

Fuentes en las que buscar. Determinarán los arrays disponibles en la respuesta. Por defecto es ['web'].

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

Categorías por las que filtrar los resultados. De forma predeterminada se establece en [], lo que significa que los resultados no se filtrarán por ninguna categoría.

tbs
string

Parámetro de búsqueda temporal. Admite intervalos de tiempo predefinidos (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y) y rangos de fechas personalizados (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY)

location
string

Parámetro de ubicación para los resultados de la búsqueda (por ejemplo, San Francisco,California,United States). Para obtener mejores resultados, configura tanto este parámetro como el parámetro country.

country
string
predeterminado:US

Código de país ISO para la segmentación geográfica de los resultados de búsqueda (por ejemplo, US). Para obtener mejores resultados, establece tanto este parámetro como el parámetro location.

timeout
integer
predeterminado:60000

Tiempo de espera en milisegundos

ignoreInvalidURLs
boolean
predeterminado:false

Excluye de los resultados de búsqueda las URLs que no son válidas para otros endpoints de Firecrawl. Esto ayuda a reducir errores si estás enviando datos desde la búsqueda a otros endpoints de la API de Firecrawl.

scrapeOptions
object

Opciones para scrapear resultados de búsqueda

Respuesta

Respuesta satisfactoria

success
boolean
data
object

Los resultados de la búsqueda. Los arrays disponibles dependerán de las fuentes que especifiques en la solicitud. De forma predeterminada, se devolverá el array web.

warning
string | null

Mensaje de advertencia si ocurre algún problema