Lewati ke isi
ID
Dapatkan kunci API
Jelajahi dokumentasi

Referensi API

YouTube Search API

Dapatkan API key

Cari video YouTube dengan kata kunci dan ambil judul, kanal, durasi, lihat jumlah dan cap jempol sebagai JSON.

Buat permintaan

Jumlah maksimum hasil pencarian yang dikembalikan.

Parameter lanjutan
Fitur
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))
Hasil dari respon HTTPOtentikasi X-API-Key

Parameter

Kirim source dan query di tingkat atas. Pilihan sumber termasuk dalam params. Bidang opsional dapat dihilangkan.

Isi permintaan

sourcestring / Wajib
Set ke youtube_search.
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 20, 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.
true atau falseBaku: Tak ditata
params.filters.3dboolean / Opsional
Set true untuk membutuhkan fitur 3d.
true atau falseBaku: Tak ditata
params.filters.4kboolean / Opsional
Set true untuk membutuhkan fitur 4k.
true atau falseBaku: Tak ditata
params.filters.creative_commonsboolean / Opsional
Set true untuk membutuhkan fitur kreatif commons.
true atau falseBaku: Tak ditata
params.filters.hdboolean / Opsional
Set true untuk membutuhkan fitur hd.
true atau falseBaku: Tak ditata
params.filters.hdrboolean / Opsional
Set true untuk membutuhkan fitur Hdr.
true atau falseBaku: Tak ditata
params.filters.liveboolean / Opsional
Set true untuk membutuhkan fitur hidup.
true atau falseBaku: Tak ditata
params.filters.locationboolean / Opsional
Set true untuk membutuhkan fitur lokasi.
true atau falseBaku: Tak ditata
params.filters.purchasedboolean / Opsional
Set true untuk membutuhkan fitur yang dibeli.
true atau falseBaku: Tak ditata
params.filters.subtitlesboolean / Opsional
Set true untuk membutuhkan fitur subtitel.
true atau falseBaku: Tak ditata
params.filters.vr180boolean / Opsional
Set true untuk membutuhkan fitur vr180.
true atau falseBaku: 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 adalah nomor yang dikembalikan, bukan katalog yang cocok dengan 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.

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 default ke 20 dan menerima 1 ke 20. Pencarian secara ekstended mendukung hingga 700 dengan tingkat penggunaan yang terpisah.

Filter milik params.filters, tidak di samping param. Omit filter untuk menggunakan YouTube 's perilaku baku. Rincian butir dikembalikan tergantung pada tipe hasil dan ketersediaan.

Semua ruas respon
RuasDeskripsi
sourcestringSumber yang diminta API.
statusstringdilakukan ketika permintaan realtime sukses.
created_atstringWaktu pembuatan respon dalam format ISO 8601.
usage.creditsnumberKredit dikenakan biaya untuk permintaan, berdasarkan rencana Anda.
results[0].querystringQuery pencarian.
results[0].totalResultsintegerJumlah hasil kembali.
results[0].resultsarrayHasil pencarian dalam urutan kembali mereka.
results[0].results[].videoIdstringYouTube video ID.
results[0].results[].titlestringJudul video.
results[0].results[].channelstringNama saluran.
results[0].results[].channelIdstring · nullableSaluran ID ketika tersedia.
results[0].results[].channelUrlstring · nullableSaluran URL ketika tersedia.
results[0].results[].durationnumber · nullableDurasi video dalam detik.
results[0].results[].durationStringstring · nullableDurasi video yang telah diformat ketika tersedia.
results[0].results[].viewCountnumber · nullableTampilkan hitungan bila tersedia.
results[0].results[].uploadDatestring · nullableUpload tanggal ketika tersedia.
results[0].results[].descriptionstring · nullableKeterangan ekscerpt, hingga karakter 500, atau null ketika tidak tersedia.
results[0].results[].thumbnailsarrayThumbnail 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. 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.

    Async permintaan dan tanda terima · Batch meminta tubuh

  2. 2. Periksa status

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

    pending / processing: polling dengan penundaan dan rasa hormat Retry-After ketika hadir. completed: Mengambil hasil. failed: memeriksa job.error.

    Baca job.status, bukan pengajuan status penerimaan.

    Periksa status Python dan cURL

    Status tugas API referensi
  3. 3. Ambil hasil

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

    Setelah 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
Pemberitahuan pelengkapan Illustratif
{
  "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"
    }
  ]
}
RuasDeskripsi
delivery_idstringIdentifikasi pengiriman stabil. Pemberitahuan duplikat memakai nilai ini; ini juga dikirim dalam header X-Delivery-Id.
idstringJob ID.
sourcestringSumber data yang diminta.
statusstringselesai atau gagal.
linksarrayStatus dan hasil link. Pemberitahuan tidak termasuk isi hasil atau kunci API.
links[].relstringdiri atau hasil.
links[].hrefstringManajemen Absolute API URL; otentikasi dengan kunci API Anda.
links[].methodstringGET.

Kontrak webhook penuh dan pembatasan URL

Galat saat pemulihan

Pencarian yang sukses dapat mengembalikan lebih sedikit item dari yang diminta. Penyaring santai atau atur permintaan sebelum mengirim permintaan lain; hasil yang kosong tidak sendiri kegagalan pekerjaan.

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: Cari video untuk suatu topik

Harga

RencanaLaju penggunaanper 1.000 permintaan standarBerlanggananPeriode kredit yang disertakan setiap billing
Bayar sesuai penggunaanUS$0,50Tanpa biaya bulananIsi ulang sesuai kebutuhan
MicroUS$0,40US$49,00 / bulan1.000 kredit (US$50,00 dari penggunaan API) included ded
StarterUS$0,35US$199,00 / bulan4.000 kredit (US$200,00 dari penggunaan API) included ded
ProUS$0,30US$499,00 / bulan10.000 kredit (US$500,00 dari penggunaan API) included ded
ScaleUS$0,25US$999,00 / bulan20.000 kredit (US$1.000,00 dari penggunaan API) included ded
BusinessUS$0,20US$1.999,00 / bulan40.000 kredit (US$2.000,00 dari penggunaan API) included ded

Satu paket akun. Kredit bersama untuk ketiga produk. Penggunaan yang tercakup dalam kredit paket tidak ditagih lagi.

Harga saat ini dan batas rencana