Skip to content
EN
Get API key
Browse documentation

API reference

YouTube Video Metadata API

Get an API key

Retrieve video metadata by YouTube video ID, including channel details, engagement counts, thumbnails, available formats and chapters.

Build a request

The 11-character ID from the video URL, not the full URL.

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))
Results in the HTTP responseX-API-Key authentication

Parameters

Send source and video_id at the top level. Source options belong in params. Optional fields can be omitted.

Request body

sourcestring / Required
Set to youtube_metadata.
video_idstring / Required
The 11-character YouTube video ID, such as FUfGcZ092b0. Accepts letters, numbers, underscores and hyphens.
Exactly 11 charactersDefault: Not set
Accepted format^[A-Za-z0-9_-]{11}$
paramsobject / Optional
Settings for this request.
Default: {}
callback_urlstring · nullable / Optional
Async and batch only. Public HTTPS completion URL on port 443, up to 2,048 characters. No user credentials or URL fragment. Omit, use null or an empty string for no notification. In a batch, set this on each query, outside params.
Default: Not set

Response options

params.include_formatsboolean / Optional
Include available media formats and their codec, resolution and bitrate information.
true or falseDefault: true
params.include_chaptersboolean / Optional
Include chapters when the video has them.
true or falseDefault: true

Response

Realtime returns status: done. Read the source output at results[0]; usage.credits records the charge.

One video's metadata includes videoId, title, channel details, duration and engagement counts.

Read the result

Save the successful JSON response as response.json. Save this as read-response.py and run python read-response.py. It uses only Python's standard library and makes no new request.

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

Both response options default to true when omitted. Disable include_formats for a smaller response when you only need metadata. Chapters appear only when requested and available. Unavailable counts may be null.

formats describes available encodings; it does not download a video. hasTranscripts and transcriptLanguages describe availability, not transcript text. Use the Download API for media and the Transcript API for text.

All response fields
FieldDescription
sourcestringThe requested API source.
statusstringdone when the realtime request succeeds.
created_atstringResponse creation time in ISO 8601 format.
usage.creditsnumberCredits charged for the request, based on your plan.
results[0].videoIdstringYouTube video ID.
results[0].titlestringVideo title.
results[0].descriptionstringFull video description.
results[0].channelstringChannel name.
results[0].channelIdstringChannel ID.
results[0].channelUrlstringChannel URL.
results[0].channelSubscriberCountnumber · nullableChannel subscriber count.
results[0].viewCountnumber · nullableView count.
results[0].likeCountnumber · nullableLike count.
results[0].commentCountnumber · nullableComment count.
results[0].uploadDatestring · nullableUpload date.
results[0].durationnumber · nullableVideo duration in seconds.
results[0].durationStringstring · nullableFormatted duration when available.
results[0].thumbnailsarrayThumbnail URLs and dimensions.
results[0].categoriesarrayVideo categories.
results[0].tagsarrayVideo tags.
results[0].ageLimitintegerAge restriction, or 0 when unrestricted.
results[0].isLivebooleanWhether the video is currently live.
results[0].wasLivebooleanWhether the video was a live stream.
results[0].hasTranscriptsbooleanWhether captions are available.
results[0].transcriptLanguagesarrayAvailable caption language codes.
results[0].formatsarray · optionalAvailable media formats when include_formats is true.
results[0].chaptersarray · optionalChapter titles, start_time and end_time in seconds, when requested and available.

The fields above describe the default JSON response. JSON, plain text and Markdown formats.

Async returns one job receipt; batch returns one per video ID. Check each job's status and retrieve its results using the returned links.

Async & batch lifecycle

Submission returns a receipt, not results. Async creates one job; batch returns a separate job in queries[] for every accepted query. Track and retrieve each job independently.

Submit to data.flashdata.dev; read job status and results from api.flashdata.dev with the same X-API-Key. The linked API basics examples use Python and cURL.

  1. 1. Save the job IDs

    Keep this source's request fields when switching to Async. For Batch, put each request inside the queries array of a JSON object. Save every returned job ID.

    Async request and receipt · Batch request body

  2. 2. Check status

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

    pending / processing: poll with a delay and respect Retry-After when present. completed: fetch results. failed: inspect job.error.

    Read job.status, not the submission receipt's status.

    Check status · Python and cURL

    Job status API reference
  3. 3. Fetch results

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

    After completion, authenticate the result read, then fetch the 302 storage URL without your API key. Save the JSON within 24 hours of completion.

    Fetch results · Python and cURL · Response formats

    Result download API reference

Polling and fetching existing results do not consume query credits. A polling timeout does not cancel the job: keep its ID instead of submitting duplicate billable work. Error codes and retry behavior.

Completion webhooks

Subscribe per query

Set callback_url at the top level of an async request, or inside each query in a batch, outside params. No separate webhook-registration request is required. Realtime requests do not send callbacks.

Use a public HTTPS URL on port 443. FlashData POSTs a notification for each job reaching completed or failed; the event contains links, not the result itself.

Acknowledge and verify

Return 2xx after durably accepting the event. Deduplicate by delivery_id, also sent as X-Delivery-Id. Redirects are not followed.

Failed deliveries retry with exponential backoff, up to 8 attempts total and at most 24 hours after completion. Keep polling as a fallback.

Callbacks are unsigned. Confirm the job ID, source and terminal status through the authenticated status endpoint before processing the notification. The delivery ID is for deduplication, not proof of authenticity.

Example webhook event and fields
Illustrative completion notification
{
  "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"
    }
  ]
}
FieldDescription
delivery_idstringStable delivery identifier. Deduplicate notifications using this value; it is also sent in the X-Delivery-Id header.
idstringJob ID.
sourcestringRequested data source.
statusstringcompleted or failed.
linksarrayStatus and result links. Notifications do not include result content or an API key.
links[].relstringself or results.
links[].hrefstringAbsolute Management API URL; authenticate with your API key.
links[].methodstringGET.

Full webhook contract and URL restrictions

Bulk file processing

Upload one video ID per line and create the Bulk job with source: youtube_metadata. Shared options apply to every ID in the file.

Source options: include_formats, include_chapters. Put them in options when creating the Bulk job.

Retrieve the completed collection as a manifest and gzip-compressed NDJSON result parts. Data sources can also deliver result parts to your cloud storage by setting options.result_storage when creating the Bulk job. Save the manifest and parts within 24 hours after the entire Bulk job completes.

Bulk processing API · Python and cURL · Batch JSON requests

Build a Bulk workflow for this source · Pause, resume and recover

Error recovery

Supply an 11-character video ID, not a full YouTube URL. A valid ID does not guarantee the video is accessible: removed, private or restricted videos can fail during processing. Missing counts may be null; absent chapters or formats are not themselves job failures.

For authentication, balance, request-format and rate-limit failures, use the shared error reference. A submission timeout may still have created a job; check existing work before retrying.

Errors and status codes · When to retry · Rate limits

Step-by-step guide: Retrieve and use video metadata

Pricing

PlansUsage ratesper 1,000 standard requestsSubscriptionsIncluded credits per billing period
Pay as you go$0.50No monthly feeTop up as needed
Micro$0.40$49.00 / month1,000 credits ($50.00 of API usage) included
Starter$0.35$199.00 / month4,000 credits ($200.00 of API usage) included
Pro$0.30$499.00 / month10,000 credits ($500.00 of API usage) included
Scale$0.25$999.00 / month20,000 credits ($1,000.00 of API usage) included
Business$0.20$1,999.00 / month40,000 credits ($2,000.00 of API usage) included

One account plan. Shared Credits across all three products. Usage covered by included credits is not charged again.

Current prices and plan limits