Playlist
A playlist's details and its videos, 100 a page. Pages after the first hold only its id, url and videos.
GET/v1/youtube/playlists1 creditHeaders
Get your API keyx-api-key*stringrequiredheaderYour API key, made in the dashboard.
Parameters
3playlist_idstringoptionalqueryA playlist's id: the list= part of its link. Give playlist_id or url.
example: PLoSWVnSA9vG9qV0CVCpg5WwEy3LiP7udY
urlstringoptionalqueryA playlist's link, or any YouTube link with its list= part. Give playlist_id or url.
max 300 chars
cursorstringoptionalqueryFor the next page: page.next_cursor from the page before. Send the other parameters again with it.
max 8192 chars
Response fields
36dataobjectThe result: one object, or a list for the endpoints that return several.
data.idstringThe playlist's id.
data.urlstringThe playlist's link.
data.titlestringnullableIts title.
data.descriptionstringnullableIts description.
data.thumbnailstringnullableIts thumbnail's link.
data.channel_idstringnullableThe id of the channel that made it.
data.channel_namestringnullableThe name of the channel that made it.
data.channel_handlestringnullableThe handle of the channel that made it, without the @.
data.video_countintegernullableHow many videos it has.
data.viewsintegernullableIts views.
data.videosarraynullableIts videos, 100 a page. From page 2, only id, url and videos are set.
data.videos[].idstringThe video's id: 11 characters.
data.videos[].urlstringThe video's link.
data.videos[].titlestringnullableIts title.
data.videos[].is_shortbooleannullableWhether it is a short. Search, which mixes both, and the video endpoint set it; elsewhere it is null.
data.videos[].thumbnailstringnullableIts thumbnail's link.
data.videos[].duration_secondsintegernullableIts length, in seconds.
data.videos[].viewsintegernullableViews: exact where YouTube shows the exact number, else YouTube's rounding (12M is 12000000).
data.videos[].publishedstringnullableHow long ago it was published, as YouTube words it: "4h ago" in some lists, "14 years ago" in others.
data.videos[].channel_idstringnullableIts channel's id.
data.videos[].channel_namestringnullableIts channel's name.
data.videos[].channel_handlestringnullableIts channel's handle, without the @.
data.videos[].badgesstring[]nullableYouTube's labels on it, such as "New", "4K" or "CC".
data.videos[].descriptionstringnullableIts description: the start of it in search results, all of it from the video endpoint.
pageobjectnullablePaging, for the endpoints that page; null for the others.
page.next_cursorstringnullableSend it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.
page.has_morebooleanoptionalWhether another page follows.
default: false
metaobjectAbout this call.
meta.platformstringThe platform: reddit, threads, tiktok or youtube.
meta.endpointstringThe endpoint's name, such as channel_videos.
meta.paramsobjectThe call's parameters, defaults included. Parameters without a value, and the cursor, are left out.
meta.request_idstringThis call's id. Quote it when you report a problem.
meta.api_versionstringThe API version that answered.
meta.fetched_atstringWhen the data was fetched from the platform (UTC).
format: date-time
meta.cachedbooleanoptionalWhether it came from our cache; fetched_at says how old it is.
default: false
Code example
curl -X GET 'https://api.socialparse.dev/v1/youtube/playlists?playlist_id=PLoSWVnSA9vG9qV0CVCpg5WwEy3LiP7udY' \ -H 'x-api-key: YOUR_API_KEY'Responses
Successful Response
{ "data": { "id": "string", "url": "string", "title": "string", "description": "string", "thumbnail": "string", "channel_id": "string", "channel_name": "string", "channel_handle": "string", "video_count": 0, "views": 0, "videos": [ { "id": "string", "url": "string", "title": "string", "is_short": true, "thumbnail": "string", "duration_seconds": 0, "views": 0, "published": "string", "channel_id": "string", "channel_name": "string", "channel_handle": "string", "badges": [ "string" ], "description": "string" } ] }, "page": { "next_cursor": "string", "has_more": false }, "meta": { "platform": "string", "endpoint": "string", "params": { "property1": "string", "property2": "string" }, "request_id": "string", "api_version": "string", "fetched_at": "2019-08-24T14:15:22Z", "cached": false }}