Parcourir la documentation
Premiers pas
Installez le SDK Python et affichez des résultats de recherche en quelques lignes de code. Exemples synchrones et asyncio inclus.
Installez le SDK
Nécessite Python 3.10+. Exécutez ces commandes dans le dossier de votre projet. Si vous utilisez déjà un environnement virtuel, installez flashdata==1.1.0 avec la commande python -m pip de cet environnement.
Installerpython3 -m venv .venv .venv/bin/python -m pip install "flashdata==1.1.0"Installerpy -3 -m venv .venv .\.venv\Scripts\python.exe -m pip install "flashdata==1.1.0"Authentifiez-vous
Créez une clé API autorisant Google Search ou réutilisez une clé autorisée. Définissez-la dans ce terminal à l’aide de la saisie masquée ci-dessous.
Ignorez la saisie si FLASHDATA_API_KEY est déjà définie. Ces exemples lisent directement la variable, sans charger de fichier .env.
Saisie masquée de la clé · Bash# Bash: paste the key into a hidden prompt, not into this command. read -r -s -p "FlashData API key: " FLASHDATA_API_KEY printf '\n' export FLASHDATA_API_KEYSaisie masquée de la clé · PowerShell# PowerShell 7: paste the key into a hidden prompt. $flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString $env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password Remove-Variable flashdataSecureKeyLancez une recherche
Enregistrez ce code dans quickstart.py, puis exécutez-le avec le même environnement virtuel. Il effectue une requête Google Search demandant jusqu’à cinq résultats et affiche les titres, les URL et les crédits consommés.
quickstart.pyimport os from flashdata import FlashData with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client: response = client.google.search("battery recycling research", num=5) if response["status"] != "done": raise RuntimeError(response) for page in response["results"]: for hit in page.get("organic", []): print(hit["title"], hit["link"]) print("Credits used:", response["usage"]["credits"])Exécuter.venv/bin/python quickstart.pyExécuter.\.venv\Scripts\python.exe quickstart.pyVérifiez le résultat
Le script se termine normalement après avoir vérifié que status vaut done. Il affiche les titres et les URL des sources, puis Credits used. Une liste organic vide constitue une réponse valide ; les résultats dépendent de votre recherche.
Exemple de sortieBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Résultats Google Search : title, link et snippet. Les autres sources ont des champs de résultat différents.
usage.credits- Coût de cette requête. Jusqu’à cinq résultats correspondent ici à une seule requête de recherche.
Essayez une autre source de données
Chaque onglet contient un script complet. Remplacez quickstart.py par un exemple et exécutez la commande de l’étape 3. Chaque exécution soumet une nouvelle requête ; la clé doit disposer de la permission indiquée pour la source.
Nécessite google_news. Affiche les titres d’articles et les liens sources de results[].news[].
import os
from flashdata import FlashData
with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
response = client.google.news("battery recycling", num=5)
if response["status"] != "done":
raise RuntimeError(response)
for page in response["results"]:
for article in page.get("news", []):
print(article.get("title"), article.get("link"))Nécessite youtube_metadata. Affiche le titre de la vidéo, sa chaîne et sa durée en secondes. Remplacez l’identifiant vidéo par celui que vous souhaitez examiner.
import os
from flashdata import FlashData
with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
response = client.youtube.metadata("dQw4w9WgXcQ", include_formats=False)
if response["status"] != "done":
raise RuntimeError(response)
for video in response["results"]:
print(video.get("title"), video.get("channel"))
print("Seconds:", video.get("duration"))Nécessite youtube_transcript. Affiche une transcription automatique anglaise existante depuis results[].fullText. La vidéo doit disposer de cette piste ; cet appel ne génère ni ne traduit de sous-titres.
import os
from flashdata import FlashData
with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
response = client.youtube.transcript("dQw4w9WgXcQ", language="en", auto=True)
if response["status"] != "done":
raise RuntimeError(response)
for track in response["results"]:
print(track.get("fullText", ""))Fonctionnalités du SDK Python
google / youtube- Google Search, News, Images, Shopping, Videos et Places ; découverte de vidéos YouTube, métadonnées, sous-titres, transcriptions et données de chaîne.
youtube.download- Soumettez une tâche de livraison audio ou vidéo dans votre stockage cloud. La permission youtube_download et une configuration de stockage sont nécessaires ; suivez l’exemple complet de téléchargement ci-dessous.
jobs / bulk- Enregistrez l’identifiant de la tâche acceptée, attendez sa fin et récupérez les résultats. Utilisez bulk pour les fichiers d’identifiants vidéo plus volumineux et reprenez les tâches existantes après un redémarrage.
account- Consultez l’accès, le solde, les tarifs, les limites et la consommation avant un traitement récurrent. Réutilisez une clé autorisée fournie par votre environnement ou votre gestionnaire de secrets.
respond_with / accept- Utilisez respond_with="markdown" pour obtenir du Markdown dans response["content"], ou accept="text/plain" pour obtenir une chaîne. Par défaut, les réponses JSON sont des dictionnaires.
Utiliser asyncio
Remplacez quickstart.py par cette version et utilisez la même commande d’exécution. AsyncFlashData expose les mêmes ressources avec await. Cet exemple attend toujours la réponse d’une recherche en temps réel ; mode="async" soumet plutôt une tâche en arrière-plan côté serveur.
Dans Jupyter ou une application dont la boucle événementielle est déjà active, utilisez await main() à la place de asyncio.run(main()). Réutilisez le client dans cette même boucle.
import asyncio
import os
from flashdata import AsyncFlashData
async def main():
async with AsyncFlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
response = await client.google.search("battery recycling research", num=5)
if response["status"] != "done":
raise RuntimeError(response)
for page in response["results"]:
for hit in page.get("organic", []):
print(hit["title"], hit["link"])
print("Credits used:", response["usage"]["credits"])
asyncio.run(main())Étapes suivantes
Si une étape échoue
- ModuleNotFoundError
- Installez et exécutez avec le même interpréteur : .venv/bin/python -m pip show flashdata (Windows : .\.venv\Scripts\python.exe -m pip show flashdata). Ne nommez pas votre script flashdata.py.
- KeyError: FLASHDATA_API_KEY / 401
- Définissez une clé API active dans le même terminal. Cet exemple ne charge pas automatiquement un fichier .env. Utilisez une clé API, pas un jeton OAuth MCP.
- 403
- Accordez à cette clé la permission de source requise par l’exemple.
- 402
- Consultez la facturation pour vérifier les crédits disponibles. Si l’essai est épuisé, rattachez la connexion à votre compte pour utiliser son solde.
- 429 / APIError
- Consultez error.retry_after et réduisez le débit des requêtes. Le SDK envoie chaque requête une seule fois, sans nouvelle tentative automatique.
- SubmissionUnknownError
- Une soumission ayant dépassé le délai peut déjà avoir été acceptée. Consultez l’historique avant de la répéter ; réutilisez l’identifiant de tâche enregistré lorsqu’il est disponible.
- asyncio.run() / running event loop
- Utilisez await main() dans un notebook ou une boucle événementielle existante. Conservez asyncio.run(main()) pour un script autonome.