Lewati ke isi
ID
Dapatkan kunci API
Jelajahi dokumentasi

Referensi API

YouTube Video Metadata API

Dapatkan API key

Ambil metadata video oleh YouTube video ID, termasuk rincian saluran, jumlah keterlibatan, thumbnails, format dan bab yang tersedia.

Buat permintaan

ID sepanjang 11 karakter dari URL video, bukan URL lengkapnya.

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_metadata",
    "video_id": "dQw4w9WgXcQ",
    "params": {
        "include_formats": False,
        "include_chapters": True,
    },
}

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 video_id di tingkat atas. Pilihan sumber termasuk dalam params. Bidang opsional dapat dihilangkan.

Isi permintaan

sourcestring / Wajib
Set ke youtube_metadata.
video_idstring / Wajib
Karakter 11-YouTube video ID, seperti FUFFGCZ092b0. Menerima surat, nomor, garis bawah dan tanda hubung.
Tepat 11 karakterBaku: Tak ditata
Format yang diterima^[A-Za-z0-9_-]{11}$
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

Opsi respon

params.include_formatsboolean / Opsional
Sertakan format media yang tersedia dan codec, resolusi dan informasi bitrate mereka.
true atau falseBaku: true
params.include_chaptersboolean / Opsional
Termasuk bab ketika video memiliki mereka.
true atau falseBaku: true

Respons

Realtime kembali status: done. Baca keluaran sumber pada results[0]; usage.credits Records the charge.

Metadata satu video termasuk videoId, judul, rincian saluran, durasi, dan jumlah keterlibatan.

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 = {name: result.get(name) for name in (
    "videoId", "title", "channel", "duration", "hasTranscripts", "transcriptLanguages"
)}
print(json.dumps(output, ensure_ascii=False, indent=2))

Kedua opsi respon baku ke true ketika diabaikan. Nonaktifkan include_formats untuk respon kecil ketika Anda hanya perlu metadata. Bab hanya muncul ketika diminta dan tersedia. Jumlah yang tidak tersedia mungkin null.

formats menjelaskan pengkodean yang tersedia; ini tidak mengunduh video. hasTranscripts dan transcriptLanguages deskripsikan ketersediaan, bukan teks transkrip. Gunakan Unduh API untuk media dan Transkrip API untuk teks.

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].videoIdstringYouTube video ID.
results[0].titlestringJudul video.
results[0].descriptionstringDeskripsi video penuh.
results[0].channelstringNama saluran.
results[0].channelIdstringSaluran ID.
results[0].channelUrlstringSaluran URL.
results[0].channelSubscriberCountnumber · nullableJumlah pelanggan saluran.
results[0].viewCountnumber · nullableLihat hitungan.
results[0].likeCountnumber · nullableSeperti hitungan.
results[0].commentCountnumber · nullableKomentar dihitung.
results[0].uploadDatestring · nullableUpload date.
results[0].durationnumber · nullableDurasi video dalam detik.
results[0].durationStringstring · nullableDurasi terformat ketika tersedia.
results[0].thumbnailsarrayThumbnail URLs dan dimensi.
results[0].categoriesarrayKategori video.
results[0].tagsarrayVideo tag.
results[0].ageLimitintegerPembatasan usia, atau 0 ketika tidak dibatasi.
results[0].isLivebooleanApakah video saat ini hidup.
results[0].wasLivebooleanApakah video itu siaran langsung.
results[0].hasTranscriptsbooleanApakah judul tersedia.
results[0].transcriptLanguagesarrayKode bahasa judul tersedia.
results[0].formatsarray · optionalFormat media yang tersedia ketika include_formats adalah true.
results[0].chaptersarray · optionalJudul Bab, start_time dan end_time dalam detik, ketika diminta dan tersedia.

Bidang di atas menggambarkan respon baku JSON. JSON, teks polos dan Markdown format.

Async mengembalikan satu pekerjaan penerimaan; batch kembali satu per video ID. 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_metadata",
  "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

Bulk pemrosesan berkas

Upload satu video ID per baris dan membuat pekerjaan Bulk dengan sumber: youtube_metadata. Pilihan bersama berlaku untuk setiap ID dalam berkas.

Opsi sumber: include_formats, include_chapters. Menempatkan mereka dalam pilihan ketika menciptakan Bulk pekerjaan.

Ambil koleksi lengkap sebagai bagian hasil manifest dan gzip- terkompresi NDJSON. Sumber data juga dapat memberikan bagian hasil ke penyimpanan awan Anda dengan mengatur options.result_storage ketika membuat pekerjaan Bulk. Simpan manifes dan bagian dalam 24 jam setelah seluruh Bulk pekerjaan selesai.

Bulk memproses API · Python dan cURL · permintaan Batch JSON

Bangun Bulk alur kerja bagi sumber ini · Jeda, lanjutkan dan pulihkan

Galat saat pemulihan

Supply an 11-character video ID, bukan penuh YouTube URL. ID yang valid tidak menjamin video dapat diakses: dihapus, pribadi atau video yang dibatasi dapat gagal selama pemrosesan. Hilang jumlah mungkin null; absen bab atau format 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: Ambil dan gunakan metadata video

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