GET
/
youtube
/
playlist
import { Supadata } from '@supadata/js';

const supadata = new Supadata({
  apiKey: 'YOUR_API_KEY',
});
const playlist = await supadata.youtube.playlist({
  id: 'https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc', // can be id or url
});
console.log(`Playlist ${playlist.title} contains ${playlist.videoCount} videos`);
{
  "id": "PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc",
  "title": "My Favorite Videos",
  "description": "A collection of my favorite videos",
  "videoCount": 25,
  "viewCount": 1000000,
  "lastUpdated": "2023-01-01T00:00:00.000Z",
  "channel": {
    "id": "UCuAXFkgsw1L7xaCfnd5JJOw",
    "name": "Rick Astley"
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string
required

YouTube playlist URL or ID. See supported URL formats.

Examples:

"https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"

"PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"

Response

Successfully fetched playlist metadata

​
id
string
required

YouTube playlist ID

Example:

"PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"

​
title
string
required

Playlist title

Example:

"My Favorite Videos"

​
videoCount
number
required

Number of videos in the playlist

Example:

25

​
channel
object
required

Channel information

​
description
string

Playlist description

Example:

"A collection of my favorite videos"

​
viewCount
number

Number of views for the playlist

Example:

1000000

​
lastUpdated
string<date-time>

When the playlist was last updated

Example:

"2023-01-01T00:00:00.000Z"