Documentatie bekijken
API-referentie
YouTube Uitgebreide zoekopdracht API
Ophalen tot 700 YouTube zoekresultaten per aanvraag, met video details, miniaturen en zoekfilters.
Stel een aanvraag samen
Maximumaantal zoekresultaten dat wordt teruggegeven.
Geavanceerde parameters
https://data.flashdata.dev/v1/queries/realtimeParameters
Verzenden source en query op het bovenste niveau. Bronopties horen in params. Optionele velden kunnen worden weggelaten.
Aanvraaginhoud
sourcestring / Vereist- Instellen op youtube_search_extended.
querystring / Vereist- Zoekopdracht.1 tot 2.000 tekensStandaard:
Niet ingesteld paramsobject / Optioneel- Settings voor dit verzoek.Standaard:
{} callback_urlstring · nullable / Optioneel- Async en alleen batch. Publieke HTTPS voltooiing URL op poort 443, tot 2,048 tekens. Geen gebruikersgegevens of URL-fragment. Gebruik null of een lege tekenreeks zonder melding. In een batch, zet dit op elke query, buiten params.Standaard:
Niet ingesteld
Aantal resultaten
params.max_resultsinteger / Optioneel- Ik heb gevraagd om het resultaat te tellen. Er kunnen minder resultaten beschikbaar zijn.1 tot 700, hele getallenStandaard:
20
Zoekfilters
params.filtersobject · nullable / Optioneel- Optionele uploaddatum, resultaattype, duur, sorteren en feature filters. Versla of gebruik null zonder filters.Standaard:
Niet ingesteld params.filters.upload_datestring / Optioneel- Filteren op uploaddatum.1 tot 2.000 tekensWaarden:
today / last_hour / this_week / this_month / this_yearStandaard:Niet ingesteld params.filters.typestring / Optioneel- Filter op resultaattype.1 tot 2.000 tekensWaarden:
video / channel / playlist / movieStandaard:Niet ingesteld params.filters.durationstring / Optioneel- Filteren op videoduur in minuten.1 tot 2.000 tekensWaarden:
<4 / 4-20 / >20Standaard:Niet ingesteld params.filters.sort_bystring / Optioneel- Resultaat bestelling. Toestaan aan de standaard bestelling van YouTube.1 tot 2.000 tekensWaarden:
rating / relevance / view_count / upload_dateStandaard:Niet ingesteld params.filters.360boolean / Optioneel- Stel true in om de 360-functie te gebruiken.
trueoffalseStandaard:Niet ingesteld params.filters.3dboolean / Optioneel- Stel true in om de 3D-functie te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.4kboolean / Optioneel- Stel true in om de 4k functie te gebruiken.
trueoffalseStandaard:Niet ingesteld params.filters.creative_commonsboolean / Optioneel- Stel true in om de creatieve commons functie te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.hdboolean / Optioneel- Stel true in om de functie hd te gebruiken.
trueoffalseStandaard:Niet ingesteld params.filters.hdrboolean / Optioneel- Stel true in om de hdr-functie te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.liveboolean / Optioneel- Stel true in om de live functie te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.locationboolean / Optioneel- Stel true in om de locatiefunctie te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.purchasedboolean / Optioneel- Stel true in om de aangeschafte functie te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.subtitlesboolean / Optioneel- Stel true in om de ondertiteling te vereisen.
trueoffalseStandaard:Niet ingesteld params.filters.vr180boolean / Optioneel- Stel true in om de vr180 functie te vereisen.
trueoffalseStandaard:Niet ingesteld
Antwoord
Realtime geeft terug status: done. Lees de bron uitvoer op results[0].results; usage.credits neemt de aanklacht op.
Zoekuitvoer bevat query, totalResults en de geretourneerde items. totalResults telt de items van dit antwoord; het is niet het totale aantal overeenkomende video's op YouTube.
Lees het resultaat
Bewaar de succesvolle JSON respons als response.json. Sla dit op als read-response.py en voer python read-response.py uit. Het gebruikt alleen de standaardbibliotheek van Python en doet geen nieuw verzoek.
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 is standaard 20 en accepteert 1 aan 700. Dit is een groter zoekopdracht, niet 700 aparte batchtaken. Grotere verzoeken kunnen langer duren; async vermijdt het openhouden van de verbinding van de indiener.
Filters horen in params.filters. Minder resultaten kunnen beschikbaar zijn, en rijke item velden kunnen null of afwezig zijn. Extended Search heeft zijn eigen gebruikssnelheid.
Alle responsvelden
| Veld | Omschrijving |
|---|---|
sourcestring | De gevraagde API bron. |
statusstring | gedaan wanneer het real-time verzoek slaagt. |
created_atstring | Aanmaaktijd voor respons in ISO 8601-formaat. |
usage.creditsnumber | Credits in rekening gebracht voor het verzoek, op basis van uw plan. |
results[0].querystring | De zoekopdracht. |
results[0].totalResultsinteger | Het aantal resultaten is teruggekeerd. |
results[0].resultsarray | Zoekresultaten in hun geretourneerde bestelling. |
results[0].results[].videoIdstring | YouTube video ID. |
results[0].results[].titlestring | Videotitel. |
results[0].results[].channelstring | Kanaalnaam. |
results[0].results[].channelIdstring · nullable | Kanaal ID indien beschikbaar. |
results[0].results[].channelUrlstring · nullable | Kanaal URL indien beschikbaar. |
results[0].results[].durationnumber · nullable | Videoduur in seconden. |
results[0].results[].durationStringstring · nullable | Geformatteerde videoduur indien beschikbaar. |
results[0].results[].viewCountnumber · nullable | Tellen weergeven indien beschikbaar. |
results[0].results[].uploadDatestring · nullable | Uploaddatum indien beschikbaar. |
results[0].results[].descriptionstring · nullable | Beschrijving fragment, tot 500 tekens, of null wanneer niet beschikbaar. |
results[0].results[].thumbnailsarray | Miniatuur URLs en afmetingen. |
De velden hierboven beschrijven het standaard JSON antwoord. JSON, platte tekst en Markdown-formaten.
Async geeft één opdrachtbon terug; batch geeft één per query. Controleer de status van elke taak en haal de resultaten ervan op met behulp van de teruggekeerde links.
Async & batch lifecycle
Indiening geeft een ontvangstbewijs terug, geen resultaten. Async creëert één taak; batch geeft een aparte taak terug in queries[] voor elke geaccepteerde vraag. Traceer en haal elke taak zelfstandig op.
Verzenden naar data.flashdata.dev; lees jobstatus en resultaten van api.flashdata.dev met dezelfde X-API-Key. De gekoppelde API basisvoorbeelden gebruiken Python en cURL.
1. De taak IDs opslaan
De verzoekenvelden van deze bron behouden bij het overschakelen naar Async. Zet voor Batch elk verzoek in de query array van een JSON object. Bewaar elke teruggekeerde baan ID.
2. Status controleren
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: peiling met vertraging en respectRetry-Afterwanneer aanwezig.completed: resultaten halen.failed: inspectiejob.error.Lees job.status, niet de status van het inzendingsbewijs.
Controleer status · Python en cURL
Job status API referentie3. Resultaten ophalen
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsNa voltooiing, authenticeer het resultaat gelezen, dan halen de 302 opslag URL zonder uw API sleutel. Bewaar de JSON binnen 24 uren na voltooiing.
Resultaten · Python en cURL ophalen · Antwoordformaten
Resultaat download API referentie
Bestudering en het ophalen van bestaande resultaten verbruiken geen query credits. Een polling timeout annuleert de taak niet: houd de ID in plaats van het indienen van dubbele factureerbare werk. Foutcodes en opnieuw proberen gedrag.
Webhooks bij voltooiing
Abonneren per query
Instellen callback_url op het hoogste niveau van een async-verzoek, of binnen elke query in een partij, buiten params. Er is geen afzonderlijk verzoek om webhook-registratie vereist. Realtime-verzoeken sturen geen terugbellers.
Gebruik een publieke HTTPS URL op poort 443. FlashData POST een melding voor elke taak bereiken completed of failed; het evenement bevat links, niet het resultaat zelf.
Bevestigen en verifiëren
Terugkeer 2xx na het duurzaam accepteren van de gebeurtenis. Dedupliceren door delivery_id, ook verzonden als X-Delivery-Id. Redirects worden niet gevolgd.
Mislukte leveringen opnieuw proberen met exponentiële backoff, tot 8 probeert totaal en maximaal 24 uren na voltooiing. Blijf peilen als een terugval.
De terugbellen zijn niet ondertekend. Bevestig de taak ID, bron- en terminalstatus via de geauthentiseerd status-eindpunt vóór de verwerking van de kennisgeving. De levering ID is voor deduplicatie, geen bewijs van authenticiteit.
Voorbeeld webhook event en velden
{
"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"
}
]
}| Veld | Omschrijving |
|---|---|
delivery_idstring | Stabiele leveringsidentificatiecode. Notificatieberichten dedupliceren met deze waarde; het wordt ook verzonden in de X-Delivery-Id header. |
idstring | Job ID. |
sourcestring | Gevraagde databron. |
statusstring | voltooid of mislukt. |
linksarray | Status en resultaat links. Meldingen bevatten geen resultaatinhoud of een API-sleutel. |
links[].relstring | zelf of resultaten. |
links[].hrefstring | Absolute Management API URL; authenticeer met je API sleutel. |
links[].methodstring | GET. |
Foutherstel
Als een grote real-time aanvraag times out, acceptatie kan onzeker zijn. Controleer de taakgeschiedenis voordat u opnieuw inlevert. Voor volgende grote zoekopdrachten, kies async en volg de geretourneerde ID.
Gebruik de gedeelde foutreferentie voor authenticatie, saldo, verzoek-formaat en snelheidslimietfouten. Een inzending timeout kan nog steeds een baan hebben gecreëerd; controleer bestaand werk voordat opnieuw te proberen.
Fouten en statuscodes · Wanneer opnieuw proberen · Maximumtarieven
Stapsgewijze handleiding: Plan een grotere zoektocht naar kandidaten