Search

POST

Buscar y, opcionalmente, hacer scraping de los resultados de búsqueda

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": {}
}
'

import requests

url = "https://api.firecrawl.dev/v1/search"

payload = {
    "query": "<string>",
    "limit": 5,
    "tbs": "<string>",
    "location": "<string>",
    "timeout": 60000,
    "ignoreInvalidURLs": False,
    "scrapeOptions": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    limit: 5,
    tbs: '<string>',
    location: '<string>',
    timeout: 60000,
    ignoreInvalidURLs: false,
    scrapeOptions: {}
  })
};

fetch('https://api.firecrawl.dev/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'limit' => 5,
    'tbs' => '<string>',
    'location' => '<string>',
    'timeout' => 60000,
    'ignoreInvalidURLs' => false,
    'scrapeOptions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v1/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v1/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v1/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "id": "<string>"
}

{
  "success": false,
  "error": "Request timed out"
}

{
  "success": false,
  "error": "An unexpected error occurred on the server."
}

Nota: Ya está disponible una versión v2 de esta API con funciones y rendimiento mejorados.

El punto de conexión /search 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: ["markdown"] para obtener el contenido completo en Markdown de cada resultado de búsqueda; de lo contrario, de forma predeterminada recibirás los resultados (url, title, description).

Operadores de consulta compatibles

Ofrecemos una variedad de operadores de consulta que te permiten filtrar mejor tus búsquedas.

Operador	Funcionalidad	Ejemplos
`""`	Hace una coincidencia exacta de una cadena de texto	`"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`
`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`

Parámetro de ubicación

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

Búsqueda por tiempo

Usa el parámetro tbs para filtrar los resultados por periodos de tiempo, incluidos los rangos de fechas personalizados. Consulta la documentación de la función de búsqueda para ver ejemplos detallados y los 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

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 búsqueda

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 canalizas datos de la búsqueda hacia otros endpoints de la API de Firecrawl.

scrapeOptions

object

Opciones para extraer resultados de búsqueda

Show child attributes

Respuesta

Respuesta correcta

success

boolean

data

object[]

Show child attributes

warning

string | null

Mensaje de advertencia si ocurre algún problema

string

El ID de la tarea de búsqueda

Buscar y, opcionalmente, hacer scraping de los resultados de búsqueda

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": {}
}
'

import requests

url = "https://api.firecrawl.dev/v1/search"

payload = {
    "query": "<string>",
    "limit": 5,
    "tbs": "<string>",
    "location": "<string>",
    "timeout": 60000,
    "ignoreInvalidURLs": False,
    "scrapeOptions": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    limit: 5,
    tbs: '<string>',
    location: '<string>',
    timeout: 60000,
    ignoreInvalidURLs: false,
    scrapeOptions: {}
  })
};

fetch('https://api.firecrawl.dev/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'limit' => 5,
    'tbs' => '<string>',
    'location' => '<string>',
    'timeout' => 60000,
    'ignoreInvalidURLs' => false,
    'scrapeOptions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v1/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v1/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v1/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "id": "<string>"
}

{
  "success": false,
  "error": "Request timed out"
}

{
  "success": false,
  "error": "An unexpected error occurred on the server."
}

Uso de la API

Endpoints de Scrape

Endpoints de Crawl

Endpoints de Map

Endpoints de Search

Endpoints de Extract

Endpoints de la cuenta

Operadores de consulta compatibles

Parámetro de ubicación

Búsqueda por tiempo

Autorizaciones

Cuerpo

Respuesta

​Operadores de consulta compatibles

​Parámetro de ubicación

​Búsqueda por tiempo

Autorizaciones

Cuerpo

Respuesta

Operadores de consulta compatibles

Parámetro de ubicación

Búsqueda por tiempo