Pesquisa

POST

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

import requests

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

payload = {
    "query": "<string>",
    "limit": 5,
    "sources": ["web"],
    "categories": [{ "type": "github" }],
    "tbs": "<string>",
    "location": "<string>",
    "country": "US",
    "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,
    sources: ['web'],
    categories: [{type: 'github'}],
    tbs: '<string>',
    location: '<string>',
    country: 'US',
    timeout: 60000,
    ignoreInvalidURLs: false,
    scrapeOptions: {}
  })
};

fetch('https://api.firecrawl.dev/v2/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/v2/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,
    'sources' => [
        'web'
    ],
    'categories' => [
        [
                'type' => 'github'
        ]
    ],
    'tbs' => '<string>',
    'location' => '<string>',
    'country' => 'US',
    '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/v2/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"sources\": [\n    \"web\"\n  ],\n  \"categories\": [\n    {\n      \"type\": \"github\"\n    }\n  ],\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"country\": \"US\",\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/v2/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"sources\": [\n    \"web\"\n  ],\n  \"categories\": [\n    {\n      \"type\": \"github\"\n    }\n  ],\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"country\": \"US\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/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  \"sources\": [\n    \"web\"\n  ],\n  \"categories\": [\n    {\n      \"type\": \"github\"\n    }\n  ],\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"country\": \"US\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}"

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

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

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

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

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.

Operador	Funcionalidade	Exemplos
`""`	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ífico	`site:firecrawl.dev`
`filetype:`	Retorna apenas resultados com uma extensão de arquivo específica	`filetype:pdf`, `-filetype:pdf`
`inurl:`	Retorna apenas resultados que incluam uma palavra na URL	`inurl:firecrawl`
`allinurl:`	Retorna apenas resultados que incluam várias palavras na URL	`allinurl:git firecrawl`
`intitle:`	Retorna apenas resultados que incluam uma palavra no título da página	`intitle:Firecrawl`
`allintitle:`	Retorna apenas resultados que incluam várias palavras no título da página	`allintitle:firecrawl playground`
`related:`	Retorna apenas resultados relacionados a um domínio específico	`related:firecrawl.dev`
`imagesize:`	Retorna apenas imagens com dimensões exatas	`imagesize:1920x1080`
`larger:`	Retorna apenas imagens maiores que as dimensões especificadas	`larger: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"
      }
    ]
  }
}

Busca por período de tempo

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

Web
Images
News

Show child attributes

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.

Show child attributes

warning

string | null

Mensagem de aviso caso ocorra algum problema

string

O ID da tarefa de pesquisa

creditsUsed

integer

O número de créditos utilizados na busca

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

import requests

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

payload = {
    "query": "<string>",
    "limit": 5,
    "sources": ["web"],
    "categories": [{ "type": "github" }],
    "tbs": "<string>",
    "location": "<string>",
    "country": "US",
    "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,
    sources: ['web'],
    categories: [{type: 'github'}],
    tbs: '<string>',
    location: '<string>',
    country: 'US',
    timeout: 60000,
    ignoreInvalidURLs: false,
    scrapeOptions: {}
  })
};

fetch('https://api.firecrawl.dev/v2/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/v2/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,
    'sources' => [
        'web'
    ],
    'categories' => [
        [
                'type' => 'github'
        ]
    ],
    'tbs' => '<string>',
    'location' => '<string>',
    'country' => 'US',
    '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/v2/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"sources\": [\n    \"web\"\n  ],\n  \"categories\": [\n    {\n      \"type\": \"github\"\n    }\n  ],\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"country\": \"US\",\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/v2/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"limit\": 5,\n  \"sources\": [\n    \"web\"\n  ],\n  \"categories\": [\n    {\n      \"type\": \"github\"\n    }\n  ],\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"country\": \"US\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/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  \"sources\": [\n    \"web\"\n  ],\n  \"categories\": [\n    {\n      \"type\": \"github\"\n    }\n  ],\n  \"tbs\": \"<string>\",\n  \"location\": \"<string>\",\n  \"country\": \"US\",\n  \"timeout\": 60000,\n  \"ignoreInvalidURLs\": false,\n  \"scrapeOptions\": {}\n}"

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

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

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

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

Usando a API

Endpoints de scraping

Endpoints de pesquisa

Endpoints de mapeamento

Endpoints de rastreamento

Endpoints de navegador

Endpoints de agente

Endpoints de extração

Endpoints de conta

Operadores de pesquisa compatíveis

Parâmetro de localização

Parâmetro country

Parâmetro `categories`

Exemplo de uso

Categoria da Resposta

Busca por período de tempo

Autorizações

Corpo

Resposta

​Operadores de pesquisa compatíveis

​Parâmetro de localização

​Parâmetro country

​Parâmetro categories

​Exemplo de uso

​Categoria da Resposta

​Busca por período de tempo

Autorizações

Corpo

Resposta

Operadores de pesquisa compatíveis

Parâmetro de localização

Parâmetro country

Parâmetro `categories`

Exemplo de uso

Categoria da Resposta

Busca por período de tempo