Aller au contenu
FR
Obtenir une clé API
Parcourir la documentation

Référence API

API de recherche YouTube

Obtenir une clé API

Recherchez des vidéos YouTube par mot-clé et récupérez leurs titres, chaînes, durées, nombres de vues et vignettes au format JSON.

Préparer une requête

Nombre maximal de résultats de recherche à renvoyer.

Paramètres avancés
Caractéristiques
POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_search",
    "query": "python",
    "params": {
        "max_results": 20,
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Résultats dans la réponse HTTPAuthentification X-API-Key

Paramètres

Envoyez source et query à la racine de l’objet JSON. Placez les options de la source dans params. Vous pouvez omettre les champs facultatifs.

Corps de la requête

sourcestring / Obligatoire
Définissez ce champ sur youtube_search.
querystring / Obligatoire
Requête de recherche.
1 à 2 000 caractèresPar défaut : Non défini
paramsobject / Facultatif
Paramètres de cette requête.
Par défaut : {}
callback_urlstring · nullable / Facultatif
Async et Batch uniquement. URL HTTPS publique de notification sur le port 443, de 2 048 caractères maximum, sans identifiants ni fragment. Omettez ce champ, ou utilisez null ou une chaîne vide pour désactiver les notifications. Dans un Batch, définissez-le pour chaque requête, en dehors de params.
Par défaut : Non défini

Nombre de résultats

params.max_resultsinteger / Facultatif
Nombre de résultats demandé. Le nombre disponible peut être inférieur.
1 à 20, nombres entiersPar défaut : 20

Filtres de recherche

params.filtersobject · nullable / Facultatif
Filtres facultatifs de date de publication, de type de résultat, de durée, de tri et de caractéristiques. Omettez ce champ ou utilisez null pour ne pas appliquer de filtres.
Par défaut : Non défini
params.filters.upload_datestring / Facultatif
Filtrez par date de publication.
1 à 2 000 caractèresValeurs : today / last_hour / this_week / this_month / this_yearPar défaut : Non défini
params.filters.typestring / Facultatif
Filtrez par type de résultat.
1 à 2 000 caractèresValeurs : video / channel / playlist / moviePar défaut : Non défini
params.filters.durationstring / Facultatif
Filtrez par durée de la vidéo en minutes.
1 à 2 000 caractèresValeurs : <4 / 4-20 / >20Par défaut : Non défini
params.filters.sort_bystring / Facultatif
Ordre des résultats. Omettez ce champ pour conserver le tri par défaut de YouTube.
1 à 2 000 caractèresValeurs : rating / relevance / view_count / upload_datePar défaut : Non défini
params.filters.360boolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique 360.
true ou falsePar défaut : Non défini
params.filters.3dboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique 3d.
true ou falsePar défaut : Non défini
params.filters.4kboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique 4k.
true ou falsePar défaut : Non défini
params.filters.creative_commonsboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique Creative Commons.
true ou falsePar défaut : Non défini
params.filters.hdboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique hd.
true ou falsePar défaut : Non défini
params.filters.hdrboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique hdr.
true ou falsePar défaut : Non défini
params.filters.liveboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique live.
true ou falsePar défaut : Non défini
params.filters.locationboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique location.
true ou falsePar défaut : Non défini
params.filters.purchasedboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique purchased.
true ou falsePar défaut : Non défini
params.filters.subtitlesboolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique subtitles.
true ou falsePar défaut : Non défini
params.filters.vr180boolean / Facultatif
Définissez ce champ sur true pour exiger la caractéristique vr180.
true ou falsePar défaut : Non défini

Réponse

Le mode temps réel renvoie status: done. Lisez le résultat de la source dans results[0].results; usage.credits indique les crédits facturés.

Le résultat contient query, totalResults et les éléments renvoyés. totalResults compte les éléments de cette réponse, pas l’ensemble des correspondances sur YouTube.

Lire le résultat

Enregistrez la réponse JSON d’une requête réussie dans response.json. Enregistrez le script ci-dessous dans read-response.py, dans le même dossier, puis exécutez python read-response.py. Il utilise uniquement la bibliothèque standard de Python et n’envoie aucune nouvelle requête.

read-response.py
import json
from pathlib import Path

response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
    raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
    print("[]")
    raise SystemExit(0)
result = response["results"][0]

output = [
    {"videoId": item.get("videoId"), "title": item.get("title"), "channel": item.get("channel")}
    for item in result.get("results", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))

max_results vaut 20 par défaut et accepte de 1 à 20. La recherche étendue accepte jusqu’à 700 résultats et possède son propre tarif d’utilisation.

Placez les filtres dans params.filters, et non à côté de params. Omettez les filtres pour conserver le comportement par défaut de YouTube. Les détails renvoyés dépendent du type de résultat et des données disponibles.

Tous les champs de réponse
ChampDescription
sourcestringSource API demandée.
statusstringdone lorsque la requête realtime réussit.
created_atstringDate et heure de création de la réponse au format ISO 8601.
usage.creditsnumberCrédits facturés pour la requête selon votre offre.
results[0].querystringRequête de recherche.
results[0].totalResultsintegerNombre de résultats renvoyés.
results[0].resultsarrayRésultats de recherche dans l’ordre renvoyé.
results[0].results[].videoIdstringIdentifiant de la vidéo YouTube.
results[0].results[].titlestringTitre de la vidéo.
results[0].results[].channelstringNom de la chaîne.
results[0].results[].channelIdstring · nullableIdentifiant de la chaîne, lorsqu’il est disponible.
results[0].results[].channelUrlstring · nullableURL de la chaîne, lorsqu’elle est disponible.
results[0].results[].durationnumber · nullableDurée de la vidéo en secondes.
results[0].results[].durationStringstring · nullableDurée de la vidéo sous forme lisible, lorsqu’elle est disponible.
results[0].results[].viewCountnumber · nullableNombre de vues, lorsqu’il est disponible.
results[0].results[].uploadDatestring · nullableDate de publication, lorsqu’elle est disponible.
results[0].results[].descriptionstring · nullableExtrait de la description, de 500 caractères maximum, ou null s’il est indisponible.
results[0].results[].thumbnailsarrayURL et dimensions des vignettes.

Les champs ci-dessus décrivent la réponse JSON par défaut. Formats JSON, texte brut et Markdown.

Async renvoie un reçu de tâche ; Batch en renvoie un par requête. Vérifiez l’état de chaque tâche et récupérez ses résultats à l’aide des liens renvoyés.

Cycle de traitement Async et Batch

La soumission renvoie un reçu, pas les résultats. Async crée une tâche ; Batch renvoie une tâche distincte dans queries[] pour chaque requête acceptée. Suivez chaque tâche et récupérez ses résultats séparément.

Soumettez les requêtes à data.flashdata.dev ; lisez l’état et les résultats sur api.flashdata.dev avec la même clé X-API-Key. Les exemples liés dans les bases de l’API utilisent Python et cURL.

  1. 1. Enregistrer les identifiants de tâche

    Conservez les champs de requête de cette source en passant à Async. Pour Batch, placez chaque requête dans le tableau queries d’un objet JSON. Enregistrez tous les identifiants de tâche renvoyés.

    Requête Async et reçu de soumission · Corps de requête Batch

  2. 2. Vérifier l’état

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing : attendez entre les vérifications et respectez Retry-After lorsqu’il est présent. completed : récupérez les résultats. failed : consultez job.error.

    Lisez job.status, et non le champ status du reçu de soumission.

    Vérifier l’état · Python et cURL

    Référence API : état d’une tâche
  3. 3. Récupérer les résultats

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    Après la fin du traitement, authentifiez la requête de lecture du résultat, puis récupérez l’URL de stockage renvoyée par la redirection 302, sans votre clé API. Enregistrez le JSON dans les 24 heures suivant la fin du traitement.

    Récupérer les résultats · Python et cURL · Formats de réponse

    Référence API : récupération des résultats

La vérification de l’état et la récupération de résultats existants ne consomment aucun crédit de requête. Un délai de vérification dépassé n’annule pas la tâche : conservez son identifiant pour éviter de soumettre des doublons facturables. Codes d’erreur et nouvelles tentatives.

Webhooks de fin de tâche

Configurer chaque requête

Définissez callback_url à la racine d’une requête Async, ou dans chaque requête d’un Batch, en dehors de params. Aucune requête distincte d’enregistrement de webhook n’est nécessaire. Les requêtes Realtime n’envoient pas de notifications.

Utilisez une URL HTTPS publique sur le port 443. FlashData envoie une notification POST pour chaque tâche atteignant l’état completed ou failed ; l’événement contient des liens, pas le résultat lui-même.

Accuser réception et vérifier

Renvoyez 2xx après avoir enregistré durablement l’événement. Dédupliquez à l’aide de delivery_id, également envoyé dans X-Delivery-Id. Les redirections ne sont pas suivies.

Les envois en échec sont retentés avec un délai exponentiel, dans la limite de 8 tentatives au total et au plus tard 24 heures après la fin du traitement. Conservez la vérification périodique de l’état comme solution de secours.

Les notifications ne sont pas signées. Vérifiez l’identifiant, la source et l’état final de la tâche via l’endpoint d’état authentifié avant de traiter la notification. L’identifiant d’envoi sert à la déduplication ; il ne prouve pas l’authenticité.

Exemple d’événement webhook et ses champs
Exemple de notification de fin de tâche
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_search",
  "status": "completed",
  "links": [
    {
      "rel": "self",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001",
      "method": "GET"
    },
    {
      "rel": "results",
      "href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
      "method": "GET"
    }
  ]
}
ChampDescription
delivery_idstringIdentifiant de livraison stable. Utilisez-le pour dédupliquer les notifications ; il est aussi envoyé dans l’en-tête X-Delivery-Id.
idstringIdentifiant de la tâche.
sourcestringSource de données demandée.
statusstringcompleted ou failed.
linksarrayLiens vers l’état et les résultats. Les notifications ne contiennent ni les résultats ni de clé API.
links[].relstringself ou results.
links[].hrefstringURL absolue de l’API de gestion ; authentifiez la requête avec votre clé API.
links[].methodstringGET.

Contrat complet des webhooks et restrictions des URL

Résoudre les erreurs

Une recherche réussie peut renvoyer moins d’éléments que demandé. Assouplissez les filtres ou ajustez la recherche avant une nouvelle requête ; un résultat vide ne constitue pas en soi un échec de la tâche.

Pour les erreurs d’authentification, de solde, de format de requête ou de limite de débit, consultez la référence commune des erreurs. Une soumission ayant dépassé le délai d’attente peut tout de même avoir créé une tâche ; vérifiez les tâches existantes avant de réessayer.

Erreurs et codes d’état · Quand réessayer · Limites de débit

Guide étape par étape : Trouver des vidéos sur un sujet

Tarifs

PlansTarifs d’utilisationpour 1 000 requêtes standardAbonnementsCrédits inclus par période de facturation
Paiement à l’usage0,50 $USPas de frais mensuelsRechargez selon vos besoins
Micro0,40 $US49,00 $US / mois1 000 crédits (50,00 $US d’utilisation de l’API) inclus
Starter0,35 $US199,00 $US / mois4 000 crédits (200,00 $US d’utilisation de l’API) inclus
Pro0,30 $US499,00 $US / mois10 000 crédits (500,00 $US d’utilisation de l’API) inclus
Scale0,25 $US999,00 $US / mois20 000 crédits (1 000,00 $US d’utilisation de l’API) inclus
Business0,20 $US1 999,00 $US / mois40 000 crédits (2 000,00 $US d’utilisation de l’API) inclus

Un seul forfait par compte. Des crédits partagés entre les trois produits. L’utilisation couverte par les crédits inclus n’est pas facturée à nouveau.

Tarifs actuels et limites des forfaits