> ## Documentation Index
> Fetch the complete documentation index at: https://student-213fb9fc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Recherche
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](https://firecrawl.dev/search_locations.json) 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"`.
```json theme={null}
{
"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
```json theme={null}
{
"query": "apprentissage automatique",
"categories": ["github", "recherche"],
"limit": 10
}
```
### Catégories de la réponse
Chaque résultat inclut un champ `category` indiquant sa source :
```json theme={null}
{
"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](https://docs.firecrawl.dev/features/search#time-based-search) pour des exemples détaillés et les formats pris en charge.
## OpenAPI
````yaml fr/api-reference/v2-openapi.json post /search
openapi: 3.0.0
info:
title: Firecrawl API
version: v2
description: >-
API pour interagir avec les services Firecrawl afin d’effectuer des tâches
de scraping et de crawling web.
contact:
name: Firecrawl Support
url: https://firecrawl.dev/support
email: support@firecrawl.dev
servers:
- url: https://api.firecrawl.dev/v2
security:
- bearerAuth: []
paths:
/search:
post:
tags:
- Search
summary: Rechercher et éventuellement scraper les résultats de recherche
operationId: searchAndScrape
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: La requête de recherche
limit:
type: integer
description: Nombre maximal de résultats à renvoyer
default: 5
maximum: 100
minimum: 1
sources:
type: array
items:
oneOf:
- type: object
title: Web
properties:
type:
type: string
enum:
- web
tbs:
type: string
description: "Paramètre de recherche temporel. Accepte des intervalles prédéfinis (`qdr:h`, `qdr:d`, `qdr:w`, `qdr:m`, `qdr:y`), des plages de dates personnalisées (`cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY`) ainsi que le tri par date (`sbd:1`). Les valeurs peuvent être combinées, par exemple\_: `sbd:1,qdr:w`."
location:
type: string
description: >-
Paramètre de localisation pour les résultats de
recherche
required:
- type
- type: object
title: Images
properties:
type:
type: string
enum:
- images
required:
- type
- type: object
title: News
properties:
type:
type: string
enum:
- news
required:
- type
description: >-
Sources à interroger. Déterminera les tableaux disponibles
dans la réponse. Valeur par défaut : ['web'].
default:
- web
categories:
type: array
items:
oneOf:
- type: object
title: GitHub
properties:
type:
type: string
enum:
- github
required:
- type
- type: object
title: Research
properties:
type:
type: string
enum:
- research
required:
- type
- type: object
title: PDF
properties:
type:
type: string
enum:
- pdf
required:
- type
description: >-
Catégories utilisées pour filtrer les résultats. Par défaut,
la valeur est [], ce qui signifie qu’aucun filtre de
catégorie ne sera appliqué aux résultats.
tbs:
type: string
description: "Paramètre de recherche temporel. Accepte des intervalles prédéfinis (`qdr:h`, `qdr:d`, `qdr:w`, `qdr:m`, `qdr:y`), des plages de dates personnalisées (`cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY`) ainsi que le tri par date (`sbd:1`). Les valeurs peuvent être combinées, par exemple\_: `sbd:1,qdr:w`."
location:
type: string
description: >-
Paramètre de localisation pour les résultats de recherche
(par ex. `San Francisco,California,United States`). Pour de
meilleurs résultats, définissez ce paramètre ainsi que le
paramètre `country`.
country:
type: string
description: >-
Code pays ISO pour le ciblage géographique des résultats de
recherche (par exemple `US`). Pour de meilleurs résultats,
définissez ce paramètre ainsi que le paramètre `location`.
default: US
timeout:
type: integer
description: Délai d'expiration en millisecondes
default: 60000
ignoreInvalidURLs:
type: boolean
description: >-
Exclut des résultats de recherche les URL qui ne sont pas
valides pour d’autres endpoints Firecrawl. Cela permet de
réduire les erreurs si vous transmettez les données issues
de la recherche vers d’autres endpoints de l’API Firecrawl.
default: false
scrapeOptions:
allOf:
- $ref: '#/components/schemas/ScrapeOptions'
description: Options pour extraire les résultats de recherche
default: {}
required:
- query
responses:
'200':
description: Réponse en cas de succès
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: object
properties:
web:
type: array
items:
type: object
properties:
title:
type: string
description: Titre du résultat de recherche
description:
type: string
description: Description du résultat de la recherche
url:
type: string
description: URL du résultat de la recherche
markdown:
type: string
nullable: true
description: >-
Contenu en Markdown si une opération de scraping
a été demandée
html:
type: string
nullable: true
description: >-
Contenu HTML si demandé dans les formats de
sortie
rawHtml:
type: string
nullable: true
description: >-
Contenu HTML brut si ce format est demandé dans
formats
links:
type: array
items:
type: string
description: >-
Liens trouvés lorsqu’ils sont demandés dans les
formats
screenshot:
type: string
nullable: true
description: >-
URL de capture d’écran si elle est demandée dans
les formats. Les captures d’écran expirent au
bout de 24 heures et ne peuvent alors plus être
téléchargées.
metadata:
type: object
properties:
title:
type: string
description:
type: string
sourceURL:
type: string
description: >-
L’URL initialement demandée. Elle peut
différer de l’URL finale de la page si des
redirections ont été appliquées.
url:
type: string
description: >-
L’URL finale de la page après application de
l’ensemble des redirections.
statusCode:
type: integer
error:
type: string
nullable: true
images:
type: array
items:
type: object
properties:
title:
type: string
description: Titre du résultat de recherche
imageUrl:
type: string
description: URL de l’image
imageWidth:
type: integer
description: Largeur de l'image
imageHeight:
type: integer
description: Hauteur de l’image
url:
type: string
description: URL du résultat de la recherche
position:
type: integer
description: Position du résultat de recherche
news:
type: array
items:
type: object
properties:
title:
type: string
description: Titre de l’article
snippet:
type: string
description: Extrait de l’article
url:
type: string
description: URL de l’article
date:
type: string
description: Date de l’article
imageUrl:
type: string
description: URL de l’image de l’article
position:
type: integer
description: Position de l’article
markdown:
type: string
nullable: true
description: Contenu Markdown si un scraping a été demandé
html:
type: string
nullable: true
description: Contenu HTML si inclus dans les formats demandés
rawHtml:
type: string
nullable: true
description: Contenu HTML brut si ce format est demandé
links:
type: array
items:
type: string
description: Liens trouvés si demandés dans les formats
screenshot:
type: string
nullable: true
description: >-
URL de la capture d’écran si demandé dans les
formats. Les captures d’écran expirent après 24
heures et ne sont alors plus téléchargeables.
metadata:
type: object
properties:
title:
type: string
description:
type: string
sourceURL:
type: string
description: >-
L’URL initialement demandée. Elle peut
différer de l’URL finale de la page si des
redirections ont été appliquées.
url:
type: string
description: >-
L’URL finale de la page après application de
l’ensemble des redirections.
statusCode:
type: integer
error:
type: string
nullable: true
description: >-
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é.
warning:
type: string
nullable: true
description: Message d’avertissement si des problèmes surviennent
id:
type: string
description: L’ID de la tâche de recherche
creditsUsed:
type: integer
description: Nombre de crédits utilisés pour la recherche
'408':
description: Délai d'attente dépassé
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Request timed out
'500':
description: Erreur du serveur
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
code:
type: string
example: UNKNOWN_ERROR
error:
type: string
example: An unexpected error occurred on the server.
security:
- bearerAuth: []
components:
schemas:
ScrapeOptions:
type: object
properties:
formats:
$ref: '#/components/schemas/Formats'
onlyMainContent:
type: boolean
description: >-
Ne renvoyez que le contenu principal de la page, en excluant les
en-têtes, éléments de navigation, pieds de page, etc.
default: true
includeTags:
type: array
items:
type: string
description: Balises à inclure dans le résultat.
excludeTags:
type: array
items:
type: string
description: Balises à exclure du résultat.
maxAge:
type: integer
description: "Retourne une version mise en cache de la page si elle est plus récente que cette durée (en millisecondes). Si une version mise en cache de la page est plus ancienne que cette valeur, la page sera à nouveau explorée (scrapée). Si vous n’avez pas besoin de données extrêmement récentes, activer cette option peut accélérer vos opérations de scraping de 500 %. Par défaut\_: 2\_jours."
default: 172800000
headers:
type: object
description: >-
En-têtes à inclure dans la requête. Peuvent être utilisés pour
envoyer des cookies, un user-agent, etc.
waitFor:
type: integer
description: >-
Indiquez un délai en millisecondes avant de récupérer le contenu,
afin de laisser à la page suffisamment de temps pour se charger. Ce
temps d’attente s’ajoute à la fonction d’attente intelligente de
Firecrawl.
default: 0
mobile:
type: boolean
description: >-
Définissez cette option sur true pour simuler le scraping depuis un
appareil mobile. Utile pour tester des pages responsives et prendre
des captures d’écran en mode mobile.
default: false
skipTlsVerification:
type: boolean
description: Ignorer la vérification du certificat TLS lors des requêtes.
default: true
timeout:
type: integer
description: >-
Délai d’expiration de la requête (en millisecondes). La valeur par
défaut est de 30 000 (30 secondes) et la valeur maximale est de 300
000 (300 secondes).
default: 30000
maximum: 300000
parsers:
type: array
description: >-
Contrôle la façon dont les fichiers sont traités lors du scraping.
Lorsque « pdf » est inclus (valeur par défaut), le contenu du PDF
est extrait et converti au format Markdown, avec une facturation
basée sur le nombre de pages (1 crédit par page). Lorsqu’un tableau
vide est envoyé, le fichier PDF est renvoyé en encodage base64 avec
un tarif fixe de 1 crédit pour l’ensemble du PDF.
items:
oneOf:
- type: object
properties:
type:
type: string
enum:
- pdf
mode:
type: string
enum:
- fast
- auto
- ocr
default: auto
description: >-
Mode d’analyse des PDF. « fast » : extraction basée
uniquement sur le texte (texte intégré, la plus rapide). «
auto » (par défaut) : tente d’abord une extraction rapide,
puis bascule vers l’OCR si nécessaire. « ocr » : impose
une analyse OCR (reconnaissance optique de caractères) sur
chaque page.
maxPages:
type: integer
minimum: 1
maximum: 10000
description: >-
Nombre maximal de pages du PDF à analyser. Doit être un
entier positif inférieur ou égal à 10 000.
required:
- type
additionalProperties: false
default:
- pdf
actions:
type: array
description: Actions à effectuer sur la page avant de récupérer le contenu
items:
oneOf:
- title: Wait
oneOf:
- type: object
title: Wait by Duration
properties:
type:
type: string
enum:
- wait
description: Attendre un nombre spécifié de millisecondes
milliseconds:
type: integer
minimum: 1
description: Nombre de millisecondes à attendre
required:
- type
- milliseconds
additionalProperties: false
- type: object
title: Wait for Element
properties:
type:
type: string
enum:
- wait
description: Attendre l’apparition d’un élément spécifique
selector:
type: string
description: Sélecteur CSS à surveiller
example: '#my-element'
required:
- type
- selector
additionalProperties: false
- type: object
title: Screenshot
properties:
type:
type: string
enum:
- screenshot
description: >-
Prenez une capture d’écran. Les liens se trouveront dans
le tableau `actions.screenshots` de la réponse.
fullPage:
type: boolean
description: >-
Indique s’il faut prendre une capture d’écran de la page
entière (en ignorant viewport.height) ou seulement de la
zone actuellement visible (viewport).
default: false
quality:
type: integer
description: >-
Qualité de la capture d’écran, de 1 à 100, 100 étant la
meilleure qualité.
viewport:
type: object
properties:
width:
type: integer
description: La largeur de la fenêtre d’affichage, en pixels
height:
type: integer
description: Hauteur du viewport en pixels
required:
- width
- height
required:
- type
- type: object
title: Click
properties:
type:
type: string
enum:
- click
description: Cliquez sur un élément
selector:
type: string
description: Sélecteur pour trouver l’élément par
example: '#load-more-button'
all:
type: boolean
description: >-
Clique sur tous les éléments correspondant au sélecteur,
et pas seulement sur le premier. Ne lève pas d’erreur si
aucun élément ne correspond au sélecteur.
default: false
required:
- type
- selector
- type: object
title: Write text
properties:
type:
type: string
enum:
- write
description: >-
Écrivez du texte dans un champ de saisie, une zone de
texte ou un élément contenteditable. Remarque : vous devez
d’abord placer le focus sur l’élément à l’aide d’une
action « click » avant d’écrire. Le texte sera saisi
caractère par caractère pour simuler une saisie au
clavier.
text:
type: string
description: Texte à saisir
example: Hello, world!
required:
- type
- text
- type: object
title: Press a key
description: >-
Appuyez sur une touche du clavier. Reportez-vous à
https://asawicki.info/nosense/doc/devices/keyboard/key_codes.html
pour la liste des codes de touches.
properties:
type:
type: string
enum:
- press
description: Appuyez sur une touche de la page
key:
type: string
description: Touche sur laquelle appuyer
example: Enter
required:
- type
- key
- type: object
title: Scroll
properties:
type:
type: string
enum:
- scroll
description: Faites défiler la page ou un élément spécifique
direction:
type: string
enum:
- up
- down
description: Sens de défilement
default: down
selector:
type: string
description: Sélecteur CSS de l’élément à faire défiler
example: '#my-element'
required:
- type
- type: object
title: Scrape
properties:
type:
type: string
enum:
- scrape
description: >-
Extrait le contenu de la page actuelle et renvoie l’URL et
le HTML.
required:
- type
- type: object
title: Execute JavaScript
properties:
type:
type: string
enum:
- executeJavascript
description: Exécuter du code JavaScript sur la page
script:
type: string
description: Code JavaScript à exécuter
example: document.querySelector('.button').click();
required:
- type
- script
- type: object
title: Generate PDF
properties:
type:
type: string
enum:
- pdf
description: >-
Génère un PDF de la page en cours. Le PDF sera renvoyé
dans le tableau `actions.pdfs` de la réponse.
format:
type: string
enum:
- A0
- A1
- A2
- A3
- A4
- A5
- A6
- Letter
- Legal
- Tabloid
- Ledger
description: Le format de page du PDF obtenu
default: Letter
landscape:
type: boolean
description: Détermine s’il faut générer le PDF au format paysage
default: false
scale:
type: number
description: Facteur d’échelle du PDF généré
default: 1
required:
- type
location:
type: object
description: >-
Paramètres de localisation pour la requête. Lorsqu’ils sont définis,
un proxy approprié sera utilisé si disponible et les paramètres de
langue et de fuseau horaire correspondants seront simulés. La valeur
par défaut est « US » si aucun n’est spécifié.
properties:
country:
type: string
description: >-
Code de pays ISO 3166-1 alpha-2 (p. ex. « US », « AU », « DE »,
« JP »)
pattern: ^[A-Z]{2}$
default: US
languages:
type: array
description: >-
Langues et paramètres régionaux préférés pour la requête, par
ordre de priorité. Utilise par défaut la langue de l’emplacement
spécifié. Voir
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
items:
type: string
example: en-US
removeBase64Images:
type: boolean
description: >-
Supprime toutes les images encodées en base64 de la sortie, car
elles peuvent être très volumineuses. Le texte alternatif de l’image
est conservé dans la sortie, mais l’URL est remplacée par une valeur
fictive.
default: true
blockAds:
type: boolean
description: >-
Active le blocage des publicités et des fenêtres contextuelles de
cookies.
default: true
proxy:
type: string
enum:
- basic
- enhanced
- auto
description: "Spécifie le type de proxy à utiliser.\n\n - **basic**\_: Proxies pour le scraping de sites avec des solutions anti‑bots inexistantes ou basiques. Rapides et généralement efficaces.\n - **enhanced**\_: Proxies renforcés pour le scraping de sites avec des solutions anti‑bots avancées. Plus lents, mais plus fiables sur certains sites. Peut coûter jusqu’à 5 crédits par requête.\n - **auto**\_: Firecrawl réessaiera automatiquement le scraping avec des proxies renforcés si le proxy basic échoue. Si la nouvelle tentative avec le proxy renforcé réussit, 5 crédits seront facturés pour l’opération de scraping. Si la première tentative avec le proxy basic réussit, seul le coût standard sera facturé."
default: auto
storeInCache:
type: boolean
description: >-
Si ce paramètre est défini sur true, la page sera stockée dans
l’index et le cache de Firecrawl. Le définir sur false est utile si
votre activité de scraping peut soulever des problèmes de protection
des données. L’utilisation de certains paramètres associés à un
scraping sensible (par ex. actions, headers) forcera ce paramètre à
false.
default: true
Formats:
type: array
items:
oneOf:
- type: object
title: Markdown
properties:
type:
type: string
enum:
- markdown
required:
- type
- type: object
title: Summary
properties:
type:
type: string
enum:
- summary
required:
- type
- type: object
title: HTML
properties:
type:
type: string
enum:
- html
required:
- type
- type: object
title: Raw HTML
properties:
type:
type: string
enum:
- rawHtml
required:
- type
- type: object
title: Links
properties:
type:
type: string
enum:
- links
required:
- type
- type: object
title: Images
properties:
type:
type: string
enum:
- images
required:
- type
- type: object
title: Screenshot
properties:
type:
type: string
enum:
- screenshot
fullPage:
type: boolean
description: >-
Indique s’il faut prendre une capture d’écran de la page
entière (en ignorant viewport.height) ou seulement de la zone
actuellement visible (viewport).
default: false
quality:
type: integer
description: >-
La qualité de la capture d’écran, sur une échelle de 1 à 100.
100 correspond à la qualité maximale.
viewport:
type: object
properties:
width:
type: integer
description: Largeur du viewport en pixels
height:
type: integer
description: La hauteur du viewport en pixels
required:
- width
- height
required:
- type
- type: object
title: JSON
properties:
type:
type: string
enum:
- json
schema:
type: object
description: >-
Le schéma à utiliser pour la sortie JSON. Doit être conforme à
[JSON Schema](https://json-schema.org/).
prompt:
type: string
description: L’invite à utiliser pour la sortie au format JSON
required:
- type
- type: object
title: Change Tracking
properties:
type:
type: string
enum:
- changeTracking
modes:
type: array
items:
type: string
enum:
- git-diff
- json
description: >-
Le mode de suivi des modifications à utiliser. « git-diff »
fournit un diff détaillé, tandis que « json » compare les
données JSON extraites.
schema:
type: object
description: >-
Schéma JSON pour l’extraction en mode « json ». Définit la
structure des données à extraire et à comparer. Doit être
conforme à [JSON Schema](https://json-schema.org/).
prompt:
type: string
description: >-
Invite (prompt) à utiliser pour le suivi des modifications en
mode « json ». S’il n’est pas fourni, l’invite (prompt) par
défaut sera utilisée.
tag:
type: string
nullable: true
default: null
description: >-
Tag à utiliser pour le suivi des modifications. Les tags
peuvent séparer l’historique du suivi des modifications en «
branches » distinctes, où le suivi avec un tag spécifique ne
sera comparé qu’aux extractions effectuées avec ce même tag.
S’il n’est pas fourni, le tag par défaut (null) sera utilisé.
required:
- type
- type: object
title: Branding
properties:
type:
type: string
enum:
- branding
required:
- type
description: >-
Formats de sortie à inclure dans la réponse. Vous pouvez spécifier un ou
plusieurs formats, soit sous forme de chaînes (par ex. `'markdown'`),
soit sous forme d’objets avec des options supplémentaires (par ex. `{
type: 'json', schema: {...} }`). Certains formats requièrent la
définition d’options spécifiques. Exemple : `['markdown', { type:
'json', schema: {...} }]`.
default:
- markdown
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````