Búsqueda

POST /search

Buscar y, opcionalmente, scrapear los resultados de búsqueda

cURL

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": [
    {}
  ],
  "tbs": "<string>",
  "location": "<string>",
  "country": "US",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {}
}
'

200

{
  "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>",
          "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>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "url": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ]
  },
  "warning": "<string>",
  "id": "<string>",
  "creditsUsed": 123
}

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.

Operador	Funcionalidad	Ejemplos
""	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ífico	site:firecrawl.dev
filetype:	Devuelve solo resultados con una extensión de archivo específica	filetype:pdf, -filetype:pdf
inurl:	Devuelve solo resultados que incluyan una palabra en la URL	inurl:firecrawl
allinurl:	Devuelve solo resultados que incluyan varias palabras en la URL	allinurl:git firecrawl
intitle:	Devuelve solo resultados que incluyan una palabra en el título de la página	intitle:Firecrawl
allintitle:	Devuelve solo resultados que incluyan varias palabras en el título de la página	allintitle:firecrawl playground
related:	Devuelve solo resultados relacionados con un dominio específico	related:firecrawl.dev
imagesize:	Devuelve solo imágenes con dimensiones exactas	imagesize:1920x1080
larger:	Devuelve solo imágenes más grandes que las dimensiones especificadas	larger: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"
      }
    ]
  }
}

​

Búsqueda por tiempo

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

Web

Images

News

Show child attributes

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.

GitHub

Research

PDF

Show child attributes

tbs · string

Parámetro de búsqueda por tiempo. Admite rangos de tiempo predefinidos (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y), rangos de fechas personalizados (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY) y ordenación por fecha (sbd:1). Los valores se pueden combinar, p. ej. sbd:1,qdr:w.

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

Show child attributes

Respuesta

200

application/json

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.

Show child attributes

warning · string | null

Mensaje de advertencia si ocurre algún problema

id · string

El ID de la tarea de búsqueda

creditsUsed · integer

El número de créditos consumidos en la búsqueda