# FlashData YouTube Video Metadata API

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

Canonical reference: https://flashdata.dev/docs/sources/youtube_metadata
Reviewed: 2026-10-23

Endpoint: POST https://data.flashdata.dev/v1/queries/realtime
Authentication: X-API-Key: YOUR_API_KEY
Modes: [Realtime](https://flashdata.dev/docs/reference/realtime-and-async/reference.md#realtime) · [Async](https://flashdata.dev/docs/reference/realtime-and-async/reference.md#async) · [Batch](https://flashdata.dev/docs/reference/batch-and-bulk/reference.md#batch) · [Bulk](https://flashdata.dev/docs/reference/bulk-processing/reference.md)

Required source permission: youtube_metadata

Replace YOUR_API_KEY with an API key that has this source permission and available credits. Run requests on your server or agent host.

[Set up authentication](https://flashdata.dev/docs/guides/headers-and-authentication/reference.md)

[Retrieve and use video metadata](https://flashdata.dev/docs/guides/video-metadata-recipe/reference.md)

<a id="quickstart"></a>

## Send a request

### Python

```bash
python3 -m pip install requests
```

```python
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},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
```

### Bash / cURL

```bash
api_key="YOUR_API_KEY"
curl --fail-with-body --max-time 120 --request POST "https://data.flashdata.dev/v1/queries/realtime" \
  --header "Content-Type: application/json" \
  --header "X-API-Key: $api_key" \
  --data-binary @- <<'FLASHDATA_JSON'
{
  "source": "youtube_metadata",
  "video_id": "dQw4w9WgXcQ",
  "params": {
    "include_formats": false,
    "include_chapters": true
  }
}
FLASHDATA_JSON
```

<a id="parameters"></a>

## Parameters

<a id="parameters-group-0"></a>

### Request body

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <a id="parameter-source"></a> source | string | Yes | — | Set to youtube_metadata.  |
| <a id="parameter-video_id"></a> video_id | string | Yes | Not set | The 11-character YouTube video ID, such as FUfGcZ092b0. Accepts letters, numbers, underscores and hyphens. Min length: 11. Max length: 11. Pattern: ^[A-Za-z0-9_-]{11}$ |
| <a id="parameter-params"></a> params | object | No | {} | Settings for this request.  |
| <a id="parameter-callback_url"></a> callback_url | string · nullable | No | Not set | 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.  |

<a id="parameters-group-1"></a>

### Response options

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <a id="parameter-params-include_formats"></a> params.include_formats | boolean | No | true | Include available media formats and their codec, resolution and bitrate information.  |
| <a id="parameter-params-include_chapters"></a> params.include_chapters | boolean | No | true | Include chapters when the video has them.  |

<a id="response"></a>

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

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

## Sample response

Recorded example; fields and counts depend on the source and requested input.
```json
{
  "source": "youtube_metadata",
  "status": "done",
  "results": [
    {
      "videoId": "dQw4w9WgXcQ",
      "title": "Rick Astley - Never Gonna Give You Up (Official Video) (4K Remaster)",
      "description": "The official video for “Never Gonna Give You Up” by Rick Astley. \n\nNever: The Autobiography 📚 OUT NOW! \nFollow this link to get your copy and listen to Rick’s ‘Never’ playlist ❤️ #RickAstleyNever\nhttps://linktr.ee/rickastleynever\n\n“Never Gonna Give You Up” was a global smash on its release in July 1987, topping the charts in 25 countries including Rick’s native UK and the US Billboard Hot 100.  It also won the Brit Award for Best single in 1988. Stock Aitken and Waterman wrote and produced the track which was the lead-off single and lead track from Rick’s debut LP “Whenever You Need Somebody”.  The album was itself a UK number one and would go on to sell over 15 million copies worldwide.\n\nThe legendary video was directed by Simon West – who later went on to make Hollywood blockbusters such as Con Air, Lara Croft – Tomb Raider and The Expendables 2.  The video passed the 1bn YouTube views milestone on 28 July 2021.\n\nSubscribe to the official Rick Astley YouTube channel: https://RickAstley.lnk.to/YTSubID\n\nFollow Rick Astley:\nFacebook: https://RickAstley.lnk.to/FBFollowID \nTwitter: https://RickAstley.lnk.to/TwitterID \nInstagram: https://RickAstley.lnk.to/InstagramID \nWebsite: https://RickAstley.lnk.to/storeID \nTikTok: https://RickAstley.lnk.to/TikTokID\n\nListen to Rick Astley:\nSpotify: https://RickAstley.lnk.to/SpotifyID \nApple Music: https://RickAstley.lnk.to/AppleMusicID \nAmazon Music: https://RickAstley.lnk.to/AmazonMusicID \nDeezer: https://RickAstley.lnk.to/DeezerID \n\nLyrics:\nWe’re no strangers to love\nYou know the rules and so do I\nA full commitment’s what I’m thinking of\nYou wouldn’t get this from any other guy\n\nI just wanna tell you how I’m feeling\nGotta make you understand\n\nNever gonna give you up\nNever gonna let you down\nNever gonna run around and desert you\nNever gonna make you cry\nNever gonna say goodbye\nNever gonna tell a lie and hurt you\n\nWe’ve known each other for so long\nYour heart’s been aching but you’re too shy to say it\nInside we both know what’s been going on\nWe know the game and we’re gonna play it\n\nAnd if you ask me how I’m feeling\nDon’t tell me you’re too blind to see\n\nNever gonna give you up\nNever gonna let you down\nNever gonna run around and desert you\nNever gonna make you cry\nNever gonna say goodbye\nNever gonna tell a lie and hurt you\n\n#RickAstley #NeverGonnaGiveYouUp #WheneverYouNeedSomebody #OfficialMusicVideo",
      "channel": "Rick Astley",
      "channelId": "UCuAXFkgsw1L7xaCfnd5JJOw",
      "channelUrl": "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw",
      "channelSubscriberCount": 4540000,
      "viewCount": 1816253015,
      "likeCount": 19394097,
      "commentCount": 2400000,
      "uploadDate": "2009-10-25T00:00:00Z",
      "duration": 213,
      "durationString": "3:33",
      "thumbnails": [
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/3.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/3.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/2.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/2.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/1.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/1.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/mq3.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/mq3.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/mq2.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/mq2.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/mq1.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/mq1.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hq3.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/hq3.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hq2.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/hq2.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hq1.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/hq1.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/sd3.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/sd3.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/sd2.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/sd2.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/sd1.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/sd1.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/default.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/default.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/mqdefault.jpg",
          "width": 320,
          "height": 180
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/mqdefault.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/0.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/0.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg?sqp=-oaymwEfCKgBEF5IVfKriqkDEggBFQAAiEIYAXABwAEGuALzGA==&rs=AOn4CLAy5pvOfmmlRtbC9v1ptqnWgPympA",
          "width": 168,
          "height": 94
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg?sqp=-oaymwEfCMQBEG5IVfKriqkDEggBFQAAiEIYAXABwAEGuALzGA==&rs=AOn4CLDnaw1sg9xedLybAaLCts8m3KNOlQ",
          "width": 196,
          "height": 110
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg?sqp=-oaymwEgCPYBEIoBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLAz-h7jukeJwLXsm6EJZ_0FIhWWgw",
          "width": 246,
          "height": 138
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLCqh65ZpY-1S9Y3vJeHWwXLcY0qUw",
          "width": 336,
          "height": 188
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/hqdefault.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/sddefault.jpg",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/sddefault.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hq720.jpg",
          "width": 1280,
          "height": 720
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/hq720.webp",
          "width": null,
          "height": null
        },
        {
          "url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
          "width": 1280,
          "height": 720
        },
        {
          "url": "https://i.ytimg.com/vi_webp/dQw4w9WgXcQ/maxresdefault.webp",
          "width": 1920,
          "height": 1080
        }
      ],
      "categories": [
        "Music"
      ],
      "tags": [
        "rick astley",
        "Never Gonna Give You Up",
        "nggyu",
        "never gonna give you up lyrics",
        "rick rolled",
        "Rick Roll",
        "rick astley official",
        "rickrolled",
        "Fortnite song",
        "Fortnite event",
        "Fortnite dance",
        "fortnite never gonna give you up",
        "rick roll",
        "rickrolling",
        "rick rolling",
        "never gonna give you up",
        "80s music",
        "rick astley new",
        "animated video",
        "rickroll",
        "meme songs",
        "never gonna give u up lyrics",
        "Rick Astley 2022",
        "never gonna let you down",
        "animated",
        "rick rolls 2022",
        "never gonna give you up karaoke"
      ],
      "ageLimit": 0,
      "isLive": false,
      "wasLive": false,
      "hasTranscripts": true,
      "transcriptLanguages": [
        "fr",
        "no",
        "ab",
        "id",
        "ta",
        "yi",
        "es-419",
        "be",
        "ro",
        "su",
        "zu",
        "ko",
        "to",
        "mk",
        "az",
        "om",
        "dz",
        "ml",
        "gd",
        "nl",
        "sk",
        "bho",
        "ay",
        "or",
        "ceb",
        "bs",
        "new",
        "gn",
        "mn",
        "mg",
        "kha",
        "haw",
        "et",
        "fy",
        "gu",
        "ht",
        "ts",
        "ca",
        "ms",
        "ur",
        "uk",
        "sw",
        "af",
        "tg",
        "ba",
        "oc",
        "st",
        "tr",
        "fa",
        "ny",
        "lo",
        "ti",
        "fo",
        "pa",
        "co",
        "ig",
        "sl",
        "ee",
        "hy",
        "kk",
        "sv",
        "cs",
        "lt",
        "tn",
        "as",
        "ky",
        "ak",
        "ja",
        "eu",
        "mt",
        "de",
        "ar",
        "dv",
        "el",
        "pl",
        "es",
        "pt-BR",
        "lua",
        "vi",
        "ka",
        "sm",
        "jv",
        "os",
        "bo",
        "de-DE",
        "sr",
        "pam",
        "war",
        "sg",
        "kri",
        "ku",
        "ps",
        "xh",
        "ug",
        "lg",
        "te",
        "so",
        "th",
        "sa",
        "iw",
        "tt",
        "zh-Hant",
        "sq",
        "hu",
        "cy",
        "da",
        "yo",
        "en-orig",
        "qu",
        "ss",
        "am",
        "it",
        "bn",
        "gl",
        "kn",
        "bg",
        "ne",
        "hi",
        "my",
        "is",
        "hmn",
        "kl",
        "fil",
        "en",
        "lv",
        "fj",
        "sn",
        "luo",
        "iu",
        "mi",
        "br",
        "km",
        "sd",
        "rn",
        "pt",
        "mfe",
        "ru",
        "si",
        "ve",
        "ha",
        "pt-PT",
        "mr",
        "hr",
        "uz",
        "nso",
        "zh-Hans",
        "ln",
        "gv",
        "la",
        "gaa",
        "lb",
        "tum",
        "tk",
        "crs",
        "aa",
        "fi",
        "rw",
        "eo",
        "ga",
        "wo"
      ]
    }
  ],
  "usage": {
    "credits": 0.01
  },
  "created_at": "2026-09-16T07:45:41.114Z"
}
```

## Response fields

| Field | Type | Description |
| --- | --- | --- |
| source | string | The requested API source. |
| status | string | done when the realtime request succeeds. |
| created_at | string | Response creation time in ISO 8601 format. |
| usage.credits | number | Credits charged for the request, based on your plan. |
| results[0].videoId | string | YouTube video ID. |
| results[0].title | string | Video title. |
| results[0].description | string | Full video description. |
| results[0].channel | string | Channel name. |
| results[0].channelId | string | Channel ID. |
| results[0].channelUrl | string | Channel URL. |
| results[0].channelSubscriberCount | number · nullable | Channel subscriber count. |
| results[0].viewCount | number · nullable | View count. |
| results[0].likeCount | number · nullable | Like count. |
| results[0].commentCount | number · nullable | Comment count. |
| results[0].uploadDate | string · nullable | Upload date. |
| results[0].duration | number · nullable | Video duration in seconds. |
| results[0].durationString | string · nullable | Formatted duration when available. |
| results[0].thumbnails | array | Thumbnail URLs and dimensions. |
| results[0].categories | array | Video categories. |
| results[0].tags | array | Video tags. |
| results[0].ageLimit | integer | Age restriction, or 0 when unrestricted. |
| results[0].isLive | boolean | Whether the video is currently live. |
| results[0].wasLive | boolean | Whether the video was a live stream. |
| results[0].hasTranscripts | boolean | Whether captions are available. |
| results[0].transcriptLanguages | array | Available caption language codes. |
| results[0].formats | array · optional | Available media formats when include_formats is true. |
| results[0].chapters | array · optional | Chapter titles, start_time and end_time in seconds, when requested and available. |

- Unavailable counts may be null. formats and chapters depend on the requested options and the video's available data.

## Response formats

Responses use JSON by default. Choose another format with these optional headers.

- Accept: application/json (default) or text/plain. Plain text presents the same fields in a readable, indented layout.
- X-Respond-With: markdown. Leave unset for original fields. Markdown works with either response format.

Markdown is available for realtime queries and completed results.

The fields below describe the default JSON response.

[Request and response format examples](https://flashdata.dev/docs/guides/response-formats/reference.md#headers)

<a id="job-lifecycle"></a>

<a id="async-batch"></a>

## API basics

The request builder and examples above use this source's parameters. Use the Python and cURL examples below for shared submission, status and result steps. A Batch body is a JSON object containing queries; each item returns its own job ID.

- [Async request and receipt](https://flashdata.dev/docs/reference/realtime-and-async/reference.md#async)

<a id="job-status"></a>

- [Check job status](https://flashdata.dev/docs/reference/realtime-and-async/reference.md#status)

<a id="job-results"></a>

- [Retrieve completed results](https://flashdata.dev/docs/reference/realtime-and-async/reference.md#results)
- [Batch JSON requests](https://flashdata.dev/docs/reference/batch-and-bulk/reference.md#batch)
- [Bulk processing API](https://flashdata.dev/docs/reference/bulk-processing/reference.md)
- [Build a Bulk workflow for this source](https://flashdata.dev/docs/reference/bulk-processing/reference.md?source=youtube_metadata#playground)
- [Customer OpenAPI](https://flashdata.dev/docs/openapi.json)

<a id="webhooks"></a>

<a id="callbacks"></a>

## Completion notifications

- [Receive and verify completion webhooks](https://flashdata.dev/docs/guides/async-batch/reference.md#webhooks)

<a id="troubleshooting"></a>

## Troubleshooting

- [Errors and status codes](https://flashdata.dev/docs/errors/reference.md#status-codes)
- [When to retry](https://flashdata.dev/docs/errors/reference.md#retries)

## Related APIs

- [YouTube Transcript API](https://flashdata.dev/docs/sources/youtube_transcript/reference.md)
- [YouTube Download API](https://flashdata.dev/docs/sources/youtube_download/reference.md)
