youtube.video_info
stable Standard may need a pack
YouTube video details: title, description, channel, views, likes, duration, publish date.
GET /v1/youtube/video_info
What you get#
One YouTube record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.
What it costs#
- Standard · 1 credit for a fresh fetch, charged only when it succeeds.
- Free when served from cache (0.2 credit for a cached response over 100 KB).
- Free if the request is invalid (never charged) or the source fails or reports not found (refunded).
Parameters#
| Name | Type | Required | Default | What it is | Constraints |
|---|---|---|---|---|---|
id | string | yes | (required) | YouTube video id | max 11 chars; must match [A-Za-z0-9_\-]{11}; trimmed |
Request#
curl "https://api.onekey.dev/v1/youtube/video_info?id=dQw4w9WgXcQ" \
-H "x-api-key: YOUR_API_KEY"Try it
Add your key to run this call right here. No key? Get one free. The key stays in this tab.
Recorded response#
A real YouTube response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.
{
"success": true,
"data": {
"content": {
"id": "dQw4w9WgXcQ",
"title": "Rick Astley - Never Gonna Give You Up (Official Video) (4K Remaster)",
"text": "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",
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"createdAt": "2009-10-25T06:57:33Z",
"category": "Music"
},
"ext": {
"isLive": false
},
"author": {
"id": "UCuAXFkgsw1L7xaCfnd5JJOw",
"displayName": "Rick Astley",
"url": "http://www.youtube.com/@RickAstleyYT"
},
"engagement": {
"views": 1821067882,
"likes": 19426982
},
"media": {
"durationSeconds": 213,
"thumbnailUrl": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg?sqp=-oaymwEbCKgBEF5IVfKriqkDDggBFQAAiEIYAXABwAEG&rs=AOn4CLDd2KtelLHaNSXrI9_5K-NvTscKNw"
}
},
"metadata": {
"platform": "youtube",
"endpoint": "video_info",
"cached": false,
"stale": false,
"age_s": 0,
"fetched_at": "2026-01-01T12:00:00+00:00",
"credits_charged": 1,
"request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
},
"error": null
}Field mapping#
How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.
| Source path | Onekey field | Transform |
|---|---|---|
videoDetails.videoId | content.id | - |
videoDetails.title | content.title | - |
videoDetails.shortDescription | content.text | - |
microformat.playerMicroformatRenderer.canonicalUrl | content.url | safeUrl |
microformat.playerMicroformatRenderer.publishDate | content.createdAt | toIsoDate |
microformat.playerMicroformatRenderer.category | content.category | - |
videoDetails.isLiveContent | ext.isLive | toBoolean |
videoDetails.channelId | author.id | - |
videoDetails.author | author.displayName | - |
microformat.playerMicroformatRenderer.ownerProfileUrl | author.url | safeUrl |
videoDetails.viewCount | engagement.views | toNumber |
microformat.playerMicroformatRenderer.likeCount | engagement.likes | toNumber |
videoDetails.lengthSeconds | media.durationSeconds | toNumber |
videoDetails.thumbnail.thumbnails.0.url | media.thumbnailUrl | safeUrl |
Caching and freshness#
- Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day the cached copy is still served instantly and marked
stale: truewhile Onekey refreshes it in the background. - If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
- A "not found" is remembered for 5 minutes and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.
What can go wrong#
| Status | Code | What to do |
|---|---|---|
| 401 | unauthorized | Check the x-api-key header. |
| 402 | insufficient_credits | Add credits; your balance must cover the price. |
| 404 | not_found | That record does not exist. Free; do not retry. |
| 422 | invalid_params | Fix the parameters using the table above. Free. |
| 429 | rate_limited | Wait Retry-After seconds, then retry. |
| 502 | upstream_error | The source failed. Refunded; retry with backoff. |
See Errors for the full list and retry guidance.
Status: stable (verified against the live source).