Recherche

POST

Rechercher et éventuellement scraper les résultats de recherche

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

L’endpoint de recherche combine la recherche web avec les capacités de scraping de Firecrawl pour renvoyer le contenu complet des pages pour n’importe quelle requête. Incluez scrapeOptions avec formats: [{"type": "markdown"}] pour obtenir le contenu markdown complet pour chaque résultat de recherche ; sinon, vous recevrez par défaut les résultats (URL, title, description). Vous pouvez également utiliser d’autres formats comme {"type": "summary"} pour un contenu condensé.

Opérateurs de requête pris en charge

Nous prenons en charge une variété d’opérateurs de requête qui vous permettent de mieux filtrer vos recherches.

Opérateur	Fonctionnalité	Exemples
`""`	Correspondance exacte (non floue) d’une chaîne de texte	`"Firecrawl"`
`-`	Exclut certains mots-clés ou annule d’autres opérateurs	`-bad`, `-site:firecrawl.dev`
`site:`	Ne renvoie que les résultats d’un site web spécifié	`site:firecrawl.dev`
`filetype:`	Ne renvoie que les résultats avec une extension de fichier spécifique	`filetype:pdf`, `-filetype:pdf`
`inurl:`	Ne renvoie que les résultats qui incluent un mot dans l’URL	`inurl:firecrawl`
`allinurl:`	Ne renvoie que les résultats qui incluent plusieurs mots dans l’URL	`allinurl:git firecrawl`
`intitle:`	Ne renvoie que les résultats qui incluent un mot dans le titre de la page	`intitle:Firecrawl`
`allintitle:`	Ne renvoie que les résultats qui incluent plusieurs mots dans le titre de la page	`allintitle:firecrawl playground`
`related:`	Ne renvoie que les résultats liés à un domaine spécifique	`related:firecrawl.dev`
`imagesize:`	Ne renvoie que les images avec des dimensions exactes	`imagesize:1920x1080`
`larger:`	Ne renvoie que les images plus grandes que les dimensions spécifiées	`larger:1920x1080`

Paramètre location

Utilisez le paramètre location pour obtenir des résultats de recherche géociblés. Format : "string". Exemples : "Germany", "San Francisco,California,United States". Consultez la liste complète des emplacements pris en charge pour tous les pays et langues disponibles.

Paramètre country

Utilisez le paramètre country pour définir le pays des résultats de recherche à l’aide des codes de pays ISO. Valeur par défaut : "US". Exemples : "US", "DE", "FR", "JP", "UK", "CA".

{
  "query": "restaurants",
  "country": "DE"
}

Paramètre `categories`

Filtrez les résultats de recherche par catégories spécifiques à l’aide du paramètre categories :

github : Rechercher dans les dépôts GitHub, le code, les tickets et la documentation
research : Rechercher sur des sites académiques et de recherche (arXiv, Nature, IEEE, PubMed, etc.)
pdf : Rechercher des fichiers PDF

Exemple d’utilisation

{
  "query": "apprentissage automatique",
  "categories": ["github", "recherche"],
  "limit": 10
}

Catégories de la réponse

Chaque résultat inclut un champ category indiquant sa source :

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

Recherche basée sur le temps

Utilisez le paramètre tbs pour filtrer les résultats par périodes, y compris avec des intervalles de dates personnalisés. Consultez la documentation de la fonctionnalité de recherche pour des exemples détaillés et les formats pris en charge.

Autorisations

Authorization

string

header

requis

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

Corps

application/json

query

string

requis

La requête de recherche

limit

integer

défaut:5

Nombre maximal de résultats à renvoyer

Plage requise: 1 <= x <= 100

sources

(Web · object | Images · object | News · object)[]

Sources à interroger. Déterminera les tableaux disponibles dans la réponse. Valeur par défaut : ['web'].

Web
Images
News

Show child attributes

Réponse

Réponse en cas de succès

success

boolean

data

object

Les résultats de la recherche. Les tableaux disponibles dépendront des sources que vous avez spécifiées dans la requête. Par défaut, le tableau web sera renvoyé.

Show child attributes

warning

string | null

Message d’avertissement si des problèmes surviennent

string

L’ID de la tâche de recherche

creditsUsed

integer

Nombre de crédits utilisés pour la recherche

Rechercher et éventuellement scraper les résultats de recherche

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

Utilisation de l’API

Points de terminaison pour le scraping

Points de terminaison pour la recherche

Points de terminaison pour la cartographie

Points de terminaison pour l’exploration

Points de terminaison pour le navigateur

Points de terminaison pour les agents

Points de terminaison pour l’extraction

Points de terminaison pour le compte

Opérateurs de requête pris en charge

Paramètre location

Paramètre country

Paramètre `categories`

Exemple d’utilisation

Catégories de la réponse

Recherche basée sur le temps

Autorisations

Corps

Réponse

​Opérateurs de requête pris en charge

​Paramètre location

​Paramètre country

​Paramètre categories

​Exemple d’utilisation

​Catégories de la réponse

​Recherche basée sur le temps

Autorisations

Corps

Réponse

Opérateurs de requête pris en charge

Paramètre location

Paramètre country

Paramètre `categories`

Exemple d’utilisation

Catégories de la réponse

Recherche basée sur le temps