Jelajahi dokumentasi
Referensi API
YouTube Pencarian Diperluas API
Ambil sampai 700 YouTube hasil pencarian per permintaan, dengan rincian video, thumbnails dan filter pencarian.
Buat permintaan
Jumlah maksimum hasil pencarian yang dikembalikan.
Parameter lanjutan
https://data.flashdata.dev/v1/queries/realtimeParameter
Kirim source dan query di tingkat atas. Pilihan sumber termasuk dalam params. Bidang opsional dapat dihilangkan.
Isi permintaan
sourcestring / Wajib- Set ke youtube_search_extended.
querystring / Wajib- Cari query.1 ke 2.000 karakterBaku:
Tak ditata paramsobject / Opsional- Settings untuk permintaan ini.Baku:
{} callback_urlstring · nullable / Opsional- Async dan batch saja. Publik HTTPS pelengkapan URL di port 443, sampai 2,048 karakter. Tak ada kredensial pengguna atau fragmen URL. Omit, gunakan null atau string kosong untuk tanpa pemberitahuan. Dalam batch, set ini pada setiap query, di luar param.Baku:
Tak ditata
Jumlah hasil
params.max_resultsinteger / Opsional- Jumlah hasil yang diminta. Sedikit hasil mungkin tersedia.1 ke 700, seluruh angkaBaku:
20
Saringan pencarian
params.filtersobject · nullable / Opsional- Tanggal unggah opsional, tipe hasil, durasi, penyortiran dan fitur. Abaikan atau gunakan null untuk tidak ada penyaring.Baku:
Tak ditata params.filters.upload_datestring / Opsional- Filter berdasarkan tanggal upload.1 ke 2.000 karakterNilai:
today / last_hour / this_week / this_month / this_yearBaku:Tak ditata params.filters.typestring / Opsional- Filter dengan tipe hasil.1 ke 2.000 karakterNilai:
video / channel / playlist / movieBaku:Tak ditata params.filters.durationstring / Opsional- Filter oleh durasi video dalam beberapa menit.1 ke 2.000 karakterNilai:
<4 / 4-20 / >20Baku:Tak ditata params.filters.sort_bystring / Opsional- Pesanan hasil. Abaikan untuk menggunakan YouTube 's default order.1 ke 2.000 karakterNilai:
rating / relevance / view_count / upload_dateBaku:Tak ditata params.filters.360boolean / Opsional- Set true untuk membutuhkan fitur 360.
trueataufalseBaku:Tak ditata params.filters.3dboolean / Opsional- Set true untuk membutuhkan fitur 3d.
trueataufalseBaku:Tak ditata params.filters.4kboolean / Opsional- Set true untuk membutuhkan fitur 4k.
trueataufalseBaku:Tak ditata params.filters.creative_commonsboolean / Opsional- Set true untuk membutuhkan fitur kreatif commons.
trueataufalseBaku:Tak ditata params.filters.hdboolean / Opsional- Set true untuk membutuhkan fitur hd.
trueataufalseBaku:Tak ditata params.filters.hdrboolean / Opsional- Set true untuk membutuhkan fitur Hdr.
trueataufalseBaku:Tak ditata params.filters.liveboolean / Opsional- Set true untuk membutuhkan fitur hidup.
trueataufalseBaku:Tak ditata params.filters.locationboolean / Opsional- Set true untuk membutuhkan fitur lokasi.
trueataufalseBaku:Tak ditata params.filters.purchasedboolean / Opsional- Set true untuk membutuhkan fitur yang dibeli.
trueataufalseBaku:Tak ditata params.filters.subtitlesboolean / Opsional- Set true untuk membutuhkan fitur subtitel.
trueataufalseBaku:Tak ditata params.filters.vr180boolean / Opsional- Set true untuk membutuhkan fitur vr180.
trueataufalseBaku:Tak ditata
Respons
Realtime kembali status: done. Baca keluaran sumber pada results[0].results; usage.credits Records the charge.
Keluaran pencarian berisi query, totalResults dan item yang dikembalikan. totalResults menghitung item respon ini; ini bukan jumlah total pencocokan video pada YouTube.
Baca hasilnya
Simpan respon JSON sukses sebagai response.json. Simpan ini sebagai read-response.py dan jalankan python read-response.py. Ini hanya menggunakan Python perpustakaan standar dan tidak membuat permintaan baru.
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 default ke 20 dan menerima 1 ke 700. Ini adalah permintaan pencarian yang lebih besar, bukan 700 yang memisahkan batch job. Permintaan yang lebih besar dapat memakan waktu lebih lama; async menghindari menjaga koneksi substance tetap terbuka.
Filter milik params.filters. Sedikit hasil mungkin tersedia, dan field item kaya dapat null atau absen. Pencarian ekstended memiliki tingkat penggunaan sendiri.
Semua ruas respon
| Ruas | Deskripsi |
|---|---|
sourcestring | Sumber yang diminta API. |
statusstring | dilakukan ketika permintaan realtime sukses. |
created_atstring | Waktu pembuatan respon dalam format ISO 8601. |
usage.creditsnumber | Kredit dikenakan biaya untuk permintaan, berdasarkan rencana Anda. |
results[0].querystring | Query pencarian. |
results[0].totalResultsinteger | Jumlah hasil kembali. |
results[0].resultsarray | Hasil pencarian dalam urutan kembali mereka. |
results[0].results[].videoIdstring | YouTube video ID. |
results[0].results[].titlestring | Judul video. |
results[0].results[].channelstring | Nama saluran. |
results[0].results[].channelIdstring · nullable | Saluran ID ketika tersedia. |
results[0].results[].channelUrlstring · nullable | Saluran URL ketika tersedia. |
results[0].results[].durationnumber · nullable | Durasi video dalam detik. |
results[0].results[].durationStringstring · nullable | Durasi video yang telah diformat ketika tersedia. |
results[0].results[].viewCountnumber · nullable | Tampilkan hitungan bila tersedia. |
results[0].results[].uploadDatestring · nullable | Upload tanggal ketika tersedia. |
results[0].results[].descriptionstring · nullable | Keterangan ekscerpt, hingga karakter 500, atau null ketika tidak tersedia. |
results[0].results[].thumbnailsarray | Thumbnail URLs dan dimensi. |
Bidang di atas menggambarkan respon baku JSON. JSON, teks polos dan Markdown format.
Async mengembalikan satu pekerjaan penerimaan; batch kembali satu per query. Periksa setiap status pekerjaan dan ambil hasilnya menggunakan link yang dikembalikan.
Async & batch lifecycle
Submission mengembalikan tanda terima, bukan hasil. Async menciptakan satu pekerjaan; batch mengembalikan pekerjaan terpisah di queries[] untuk setiap permintaan diterima. Lacak dan ambil setiap pekerjaan secara independen.
Kirim ke data.flashdata.dev; membaca status pekerjaan dan hasil dari api.flashdata.dev dengan X-API-Key yang sama. Contoh dasar API terkait menggunakan Python dan cURL.
1. Simpan pekerjaan IDs
Simpan ruas permintaan sumber ini ketika beralih ke Async. Untuk Batch, masukkan setiap permintaan ke dalam daftar array dari objek JSON. Simpan setiap pekerjaan yang kembali ID.
2. Periksa status
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: polling dengan penundaan dan rasa hormatRetry-Afterketika hadir.completed: Mengambil hasil.failed: memeriksajob.error.Baca job.status, bukan pengajuan status penerimaan.
Periksa status Python dan cURL
Status tugas API referensi3. Ambil hasil
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsSetelah selesai, otentikasi hasil dibaca, kemudian ambil penyimpanan 302 URL tanpa kunci API Anda. Simpan JSON dalam waktu penyelesaian 24.
Ambil hasil Python dan cURL · Format respons
Hasil download referensi API
Polling dan mengambil hasil yang sudah ada jangan mengkonsumsi kredit query. Pengungutan waktu pemungutan suara tidak membatalkan pekerjaan: menyimpan ID nya sebagai ganti mengirimkan duplikat pekerjaan yang dapat ditagih. Galat kode dan coba lagi perilaku.
Webhook penyelesaian
Berlangganan setiap kueri
Set callback_url pada tingkat atas permintaan async, atau didalam setiap query dalam batch, di luar params. Tak ada permintaan pendaftaran web-hook- terpisah yang diperlukan. permintaan Realtime tidak mengirim callbacks.
Gunakan publik HTTPS URL di port 443. FlashData POSTs pemberitahuan untuk setiap pekerjaan mencapai completed atau failed; peristiwa ini berisi taut, bukan hasil itu sendiri.
Mengakui dan memverifikasi
Kembali 2xx Setelah lama menerima acara itu. Deduplikasi oleh delivery_id, juga dikirim sebagai X-Delivery-Id. Redireksi tidak diikuti.
Gagal pengiriman coba ulang dengan backoff eksponensial, sampai 8 mencoba total dan paling banyak 24 jam setelah selesai. Tetap polling sebagai mundur.
Callbacks tidak ditandatangani. Konfirmasi tugas ID, status sumber dan terminal melalui titik akhir status yang terotentikasi sebelum memproses pemberitahuan. Pengiriman ID adalah untuk deduplikasi, bukan bukti keaslian.
Contoh acara webhook dan ruas
{
"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"
}
]
}| Ruas | Deskripsi |
|---|---|
delivery_idstring | Identifikasi pengiriman stabil. Pemberitahuan duplikat memakai nilai ini; ini juga dikirim dalam header X-Delivery-Id. |
idstring | Job ID. |
sourcestring | Sumber data yang diminta. |
statusstring | selesai atau gagal. |
linksarray | Status dan hasil link. Pemberitahuan tidak termasuk isi hasil atau kunci API. |
links[].relstring | diri atau hasil. |
links[].hrefstring | Manajemen Absolute API URL; otentikasi dengan kunci API Anda. |
links[].methodstring | GET. |
Galat saat pemulihan
Jika permintaan realtime besar kali keluar, penerimaan mungkin tidak pasti. Periksa riwayat pekerjaan sebelum mengajukan kembali. Untuk pencarian besar berikutnya, pilih async dan lacak kembali ID yang kembali.
Untuk otentikasi, keseimbangan, format persyaratan, dan rate-batasi kegagalan, gunakan referensi galat bersama. Tenggat pengiriman mungkin masih menciptakan suatu pekerjaan; periksa pekerjaan yang telah ada sebelum mencoba kembali.
Kesalahan dan kode status · Kapan untuk mencoba lagi · Batas rate
Panduan langkah-demi-langkah: Rencana pencarian kandidat yang lebih besar