Überspringen zum Inhalt
DE
API-Schlüssel
Dokumentation durchsuchen

API-Referenz

YouTube Suggestions API

API-Schlüssel erstellen

Abrufen von YouTube-Autovervollständigung von Vorschlägen für ein Keyword oder eine Phrase mit Sprach- und Regionssteuerung.

Anfrage erstellen

Sprachcode für Untertitel oder Vorschläge, zum Beispiel en.

Ländercode mit zwei Buchstaben, zum Beispiel US.

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_suggestions",
    "query": "python",
    "params": {
        "language": "en",
        "region": "us",
    },
}

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))
Ergebnisse in der HTTP AntwortX-API-Key-Authentifizierung

Parameter

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_suggestions.
querystring / Erforderlich
Suchpräfix.
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

Sprache & Region

params.languagestring / Optional
Sprachcode.
1 bis 35 ZeichenStandard: "en"
Akzeptiertes Format^[A-Za-z0-9-]+$
params.regionstring / Optional
Zwei-Buchstaben-Ländercode, wie US, GB oder DE.
Genau 2 ZeichenStandard: "US"
Akzeptiertes Format^[A-Za-z]{2}$

Antwort

Realtime zurück status: done. Lesen Sie den Source Output auf results[0]; usage.credits die Ladung aufzeichnet.

results[0] ist ein Array von vorgeschlagenen Suchphrasen, nicht von Videoobjekten. Es kann leer sein; es gibt kein Video IDs oder Engagement zählt in dieser Antwort.

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.

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 = result  # An array of phrases, including an empty array.
print(json.dumps(output, ensure_ascii=False, indent=2))

Senden Sie das Suchpräfix als Abfrage. language und die Region mit zwei Buchstaben gehören in Params; Defaults sind en und US. Sie beeinflussen den autocomplete-kontext, nicht video-metadaten.

Verwenden Sie Search oder Extended Search mit einer vorgeschlagenen Phrase zu discover Videos. Vorschläge unterstützen max_results oder Suchfilter nicht.

Alle Antwortfelder
FeldBeschreibung
sourcestringDie angeforderte API-Quelle.
statusstringDies geschieht, wenn die Echtzeitanforderung erfolgreich ist.
created_atstringAntworterstellungszeit im Format ISO 8601.
usage.creditsnumberCredits, die für die anfrage berechnet werden, basierend auf ihrem plan.
results[0]array<string>Autocomplete Vorschläge. Jeder Array-Eintrag ist eine vorgeschlagene Suchphrase.

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

    Async Anfrage und Empfang · Batch Anfragestelle

  2. 2. Kontrollstatus

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

    pending / processing: Umfrage mit Verzögerung und Respekt Retry-After wenn vorhanden. completed: Ergebnisse holen. failed: Inspektion job.error.

    Lesen Sie job.status, nicht den Status der Eingangsbestätigung.

    Prüfstatus · Python und cURL

    Stellenstatus API-Referenz
  3. 3. Abrufergebnisse

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

    Nach 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
Illustrative Abschlussmeldung
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_suggestions",
  "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"
    }
  ]
}
FeldBeschreibung
delivery_idstringStabile Lieferkennung. Deduplizieren Sie Benachrichtigungen mit diesem Wert; es wird auch im X-Delivery-Id-Header gesendet.
idstringJob ID.
sourcestringAngeforderte Datenquelle.
statusstringvervollständigt oder fehlgeschlagen.
linksarrayStatus- und Ergebnislinks. Benachrichtigungen enthalten keinen Ergebnisinhalt oder einen API-Schlüssel.
links[].relstringSelbst oder Ergebnisse.
links[].hrefstringAbsolute Management API URL; Authentifizierung mit Ihrem API-Schlüssel.
links[].methodstringGET.

Full Webhook Vertrag und URL Einschränkungen

Fehlerbehebung

Keine Vorschläge für ein Präfix ist eine erfolgreiche leere Antwort. Passen Sie bei Bedarf das Präfix, die Sprache oder die Region an; behandeln Sie ein leeres Array nicht als fehlgeschlagenen Job.

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: Verwandeln Sie Vorschläge in eine Suche

Preise

PläneNutzungssätzepro 1.000 StandardanfragenAbonnementsInklusive Credits pro Abrechnungszeitraum
Nutzungsabhängige Zahlung0,50 $Keine MonatsgebührBei Bedarf aufladen
Micro0,40 $49,00 $ / Monat1.000 Credits (50,00 $ von API Nutzung) enthalten
Starter0,35 $199,00 $ / Monat4.000 Credits (200,00 $ von API Nutzung) enthalten
Pro0,30 $499,00 $ / Monat10.000 Credits (500,00 $ von API Nutzung) enthalten
Scale0,25 $999,00 $ / Monat20.000 Credits (1.000,00 $ von API Nutzung) enthalten
Business0,20 $1.999,00 $ / Monat40.000 Credits (2.000,00 $ von API Nutzung) enthalten

Ein Kontotarif. Gemeinsames Guthaben für alle drei Produkte. Durch enthaltenes Guthaben gedeckte Nutzung wird nicht erneut berechnet.

Aktuelle Preise und Planlimits