Dokumentation durchsuchen
API-Referenz
YouTube Erweiterte Suche API
Abrufen bis zu 700 YouTube Suchergebnisse pro Anfrage, mit Videodetails, Miniaturansichten und Suchfiltern.
Anfrage erstellen
Maximale Anzahl der zurückgegebenen Suchergebnisse.
Erweiterte Parameter
https://data.flashdata.dev/v1/queries/realtimeParameter
Senden source und query auf der obersten Ebene. Source-Optionen gehören in params. Optionale Felder können entfallen.
Anfrageinhalt
sourcestring / Erforderlich- Setzen Sie auf youtube_search_extended.
querystring / Erforderlich- Suchanfrage.1 bis 2.000 ZeichenStandard:
Nicht eingestellt paramsobject / Optional- Settings für diese Anfrage.Standard:
{} callback_urlstring · nullable / Optional- Async und Batch nur. Öffentliche HTTPS Fertigstellung URL auf Port 443, bis zu 2,048 Zeichen. Keine Benutzeranmeldeinformationen oder URL-Fragment. Verwenden Sie null oder einen leeren String für keine Benachrichtigung. Setzen Sie dies in einem Batch auf jede Abfrage, außerhalb von Params.Standard:
Nicht eingestellt
Ergebniszahl
params.max_resultsinteger / Optional- Angeforderte Ergebniszahl. Möglicherweise stehen weniger Ergebnisse zur Verfügung.1 bis 700, ganze ZahlenStandard:
20
Suchfilter
params.filtersobject · nullable / Optional- Optionale Upload-Datum, Ergebnistyp, Dauer, Sortierung und Feature-Filter. Verwenden Sie null für keine Filter.Standard:
Nicht eingestellt params.filters.upload_datestring / Optional- Filtern nach Upload-Datum.1 bis 2.000 ZeichenWerte:
today / last_hour / this_week / this_month / this_yearStandard:Nicht eingestellt params.filters.typestring / Optional- Filtern nach Ergebnistyp.1 bis 2.000 ZeichenWerte:
video / channel / playlist / movieStandard:Nicht eingestellt params.filters.durationstring / Optional- Filtern Sie nach Videodauer in Minuten.1 bis 2.000 ZeichenWerte:
<4 / 4-20 / >20Standard:Nicht eingestellt params.filters.sort_bystring / Optional- Ergebnisbestellung. Verwenden Sie die Standard-Ordnung von YouTube nicht.1 bis 2.000 ZeichenWerte:
rating / relevance / view_count / upload_dateStandard:Nicht eingestellt params.filters.360boolean / Optional- Stellen Sie true so ein, dass die 360-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.3dboolean / Optional- Stellen Sie true so ein, dass die 3D-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.4kboolean / Optional- Stellen Sie true so ein, dass die 4k-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.creative_commonsboolean / Optional- Stellen Sie true so ein, dass die Creative Commons-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.hdboolean / Optional- Stellen Sie true so ein, dass die hd-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.hdrboolean / Optional- Stellen Sie true so ein, dass die hdr-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.liveboolean / Optional- Stellen Sie true so ein, dass die Live-Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.locationboolean / Optional- Stellen Sie true so ein, dass die Standortfunktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.purchasedboolean / Optional- Stellen Sie true so ein, dass die gekaufte Funktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.subtitlesboolean / Optional- Stellen Sie true so ein, dass die Untertitelfunktion erforderlich ist.
trueoderfalseStandard:Nicht eingestellt params.filters.vr180boolean / Optional- Stellen Sie true so ein, dass die Funktion vr180 erforderlich ist.
trueoderfalseStandard:Nicht eingestellt
Antwort
Realtime zurück status: done. Lesen Sie den Source Output auf results[0].results; usage.credits die Ladung aufzeichnet.
Die Suchausgabe enthält Abfrage, totalResults und die zurückgegebenen Elemente. totalResults zählt die Elemente dieser Antwort; es ist nicht die Gesamtzahl der übereinstimmenden Videos auf YouTube.
Lesen Sie das Ergebnis
Speichern Sie die erfolgreiche JSON-Antwort als response.json. Speichern Sie dies als read-response.py und führen Sie Python read-response.py aus. Es verwendet nur die Standardbibliothek von Python und stellt keine neue Anforderung.
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 ist standardmäßig 20 und akzeptiert 1 zu 700. Dies ist eine größere Suchanfrage, nicht 700 separate Batch-Jobs. Größere Anfragen können länger dauern; async vermeidet es, die Verbindung des Einreichers offen zu halten.
Filter gehören in params.filters. Möglicherweise stehen weniger Ergebnisse zur Verfügung, und Rich-Element-Felder können null sein oder fehlen. Extended Search hat eine eigene Nutzungsrate.
Alle Antwortfelder
| Feld | Beschreibung |
|---|---|
sourcestring | Die angeforderte API-Quelle. |
statusstring | Dies geschieht, wenn die Echtzeitanforderung erfolgreich ist. |
created_atstring | Antworterstellungszeit im Format ISO 8601. |
usage.creditsnumber | Credits, die für die anfrage berechnet werden, basierend auf ihrem plan. |
results[0].querystring | Die Suchanfrage. |
results[0].totalResultsinteger | Anzahl der zurückgegebenen Ergebnisse. |
results[0].resultsarray | Suchergebnisse in ihrer zurückgegebenen Bestellung. |
results[0].results[].videoIdstring | YouTube Video ID. |
results[0].results[].titlestring | Videotitel. |
results[0].results[].channelstring | Kanalname. |
results[0].results[].channelIdstring · nullable | Kanal ID, wenn verfügbar. |
results[0].results[].channelUrlstring · nullable | Kanal URL, wenn verfügbar. |
results[0].results[].durationnumber · nullable | Videodauer in Sekunden. |
results[0].results[].durationStringstring · nullable | Formatierte Videodauer, wenn verfügbar. |
results[0].results[].viewCountnumber · nullable | View Count, wenn verfügbar. |
results[0].results[].uploadDatestring · nullable | Upload-Datum, wenn verfügbar. |
results[0].results[].descriptionstring · nullable | Beschreibungsauszug, bis zu 500-Zeichen oder null, wenn nicht verfügbar. |
results[0].results[].thumbnailsarray | Thumbnail URLs und Abmessungen. |
Die obigen Felder beschreiben die Standardantwort von JSON. JSON, Klartext und Markdown Formate.
Async gibt eine Auftragsbestätigung zurück; Batch gibt eine pro Auftrag zurück Abfrage. Überprüfen Sie den Status jedes Jobs und rufen Sie seine Ergebnisse mit den zurückgegebenen Links ab.
Async & Batch-Lebenszyklus
Die Einreichung gibt eine Quittung zurück, keine Ergebnisse. Async erstellt einen Job; batch gibt einen separaten Job in queries[] Für jede akzeptierte Abfrage. Verfolgen und Abrufen jedes Jobs unabhängig.
Einreichen von data.flashdata.dev; lesen Sie den Jobstatus und die Ergebnisse von api.flashdata.dev mit dem gleichen X-API-Key. Die verknüpften API-Grundlagenbeispiele verwenden Python und cURL.
1. Speichern Sie den Job IDs
Behalten Sie die Anforderungsfelder dieser Quelle bei, wenn Sie zu Async wechseln. Legen Sie für Batch jede Anfrage in das Abfrage-Array eines JSON-Objekts. Speichern Sie jeden zurückgegebenen Job ID.
2. Kontrollstatus
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: Umfrage mit Verzögerung und RespektRetry-Afterwenn vorhanden.completed: Ergebnisse holen.failed: Inspektionjob.error.Lesen Sie job.status, nicht den Status der Eingangsbestätigung.
Stellenstatus API-Referenz3. Abrufergebnisse
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsNach Abschluss authentifizieren Sie das gelesene Ergebnis und holen dann den 302-Speicher URL ohne Ihren API-Schlüssel ab. Speichern Sie den JSON innerhalb von 24 Stunden nach Fertigstellung.
Ergebnisse abrufen · Python und cURL · Antwortformate
Ergebnis Download API Referenz
Das Abfragen und Abrufen vorhandener Ergebnisse verbraucht keine Abfragegutschriften. Ein Polling-Timeout storniert den Job nicht: Behalten Sie seinen ID, anstatt doppelt abrechenbare Arbeit einzureichen. Fehlercodes und Wiederholverhalten.
Webhooks bei Abschluss
Abonnieren pro Abfrage
Setz callback_url auf der obersten Ebene einer async-Anfrage oder In jeder Abfrage in einer Charge, außen params. Es ist keine separate Webhook-Registrierungsanforderung erforderlich. Realtime-Anfragen senden keine Rückrufe.
Verwenden Sie ein öffentliches HTTPS URL auf Port 443. FlashData POST eine Benachrichtigung für jeden Job, der erreicht wird completed oder failed; Das Ereignis enthält Links, nicht das Ergebnis selbst.
Bestätigung und Überprüfung
Rückkehr 2xx nach dauerhafter Annahme des Ereignisses. Dedupliziert von delivery_id, auch gesendet als X-Delivery-Id. Redirects werden nicht befolgt.
Fehlgeschlagene Lieferungen wiederholen sich mit exponentiellem Backoff, bis zu 8 Versuche insgesamt und höchstens 24 Stunden nach Fertigstellung. Führen Sie Umfragen als Rückfall.
Callbacks sind nicht signiert. Bestätigen Sie den Job ID, den Quell- und Terminalstatus durch die authentifizierter Statusendpunkt vor der Bearbeitung der Benachrichtigung. Die Lieferung ID dient der Deduplizierung, nicht dem Nachweis der Echtheit.
Beispiel Webhook Event und Felder
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_search_extended",
"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"
}
]
}| Feld | Beschreibung |
|---|---|
delivery_idstring | Stabile Lieferkennung. Deduplizieren Sie Benachrichtigungen mit diesem Wert; es wird auch im X-Delivery-Id-Header gesendet. |
idstring | Job ID. |
sourcestring | Angeforderte Datenquelle. |
statusstring | vervollständigt oder fehlgeschlagen. |
linksarray | Status- und Ergebnislinks. Benachrichtigungen enthalten keinen Ergebnisinhalt oder einen API-Schlüssel. |
links[].relstring | Selbst oder Ergebnisse. |
links[].hrefstring | Absolute Management API URL; Authentifizierung mit Ihrem API-Schlüssel. |
links[].methodstring | GET. |
Fehlerbehebung
Wenn eine große Echtzeit-Anfrage ausfällt, kann die Akzeptanz unsicher sein. Überprüfen Sie den Jobverlauf, bevor Sie erneut einreichen. Für nachfolgende große Suchanfragen wählen Sie async und verfolgen Sie das zurückgegebene ID.
Für Authentifizierungs-, Balance-, Request-Format- und Rate-Limit-Fehler verwenden Sie die gemeinsame Fehlerreferenz. Ein Einreichungs-Timeout hat möglicherweise immer noch einen Job erstellt; Überprüfen Sie die vorhandene Arbeit, bevor Sie erneut versuchen.
Fehler und Statuscodes · Wann man es erneut versucht · Zinsbindungen
Schritt-für-Schritt Anleitung: Planen Sie eine größere Kandidatensuche