YouTube playlist API

Get a playlist and a page of its videos

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/playlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "playlistId": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({playlistId: 'PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI'})
};

fetch('https://api.stophy.dev/v1/youtube/playlist', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/youtube/playlist"

payload = { "playlistId": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "video",
        "videoUrl": "<string>",
        "isShort": true,
        "isLive": true,
        "videoId": "<string>",
        "title": "<string>",
        "channelId": "<string>",
        "channelName": "<string>",
        "channelUrl": "<string>",
        "channelUsername": "<string>",
        "durationSeconds": 0,
        "views": 0,
        "thumbnailUrl": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "playlistId": "<string>",
    "playlistUrl": "<string>",
    "title": "<string>",
    "description": "<string>",
    "channelId": "<string>",
    "channelName": "<string>",
    "channelUrl": "<string>",
    "channelUsername": "<string>",
    "videos": 0,
    "views": 0,
    "thumbnailUrl": "<string>",
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

youtube

playlist

Get a playlist and a page of its videos

curl --request POST \
  --url https://api.stophy.dev/v1/youtube/playlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "playlistId": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({playlistId: 'PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI'})
};

fetch('https://api.stophy.dev/v1/youtube/playlist', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/youtube/playlist"

payload = { "playlistId": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "type": "video",
        "videoUrl": "<string>",
        "isShort": true,
        "isLive": true,
        "videoId": "<string>",
        "title": "<string>",
        "channelId": "<string>",
        "channelName": "<string>",
        "channelUrl": "<string>",
        "channelUsername": "<string>",
        "durationSeconds": 0,
        "views": 0,
        "thumbnailUrl": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "playlistId": "<string>",
    "playlistUrl": "<string>",
    "title": "<string>",
    "description": "<string>",
    "channelId": "<string>",
    "channelName": "<string>",
    "channelUrl": "<string>",
    "channelUsername": "<string>",
    "videos": 0,
    "views": 0,
    "thumbnailUrl": "<string>",
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Returns a playlist and a page of its videos. The playlist is identified by its URL or ID.

Request

Exactly one of playlistUrl or playlistId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.youtube.playlist({ playlistId: "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.youtube.playlist(playlist_id="PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/youtube/playlist \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"playlistId":"PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI"}'

stophy youtube playlist --playlistId PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI

Response

If successful, the response body contains the standard envelope. data contains the playlist’s details, and results lists a page of its videos. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "playlistId": "PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI",
    "playlistUrl": "https://www.youtube.com/playlist?list=PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI",
    "title": "Popular Music Videos",
    "channelId": "UC-9-kyTW8ZkZNDHQJ6FgpwQ",
    "channelName": "Music",
    "channelUrl": "https://www.youtube.com/channel/UC-9-kyTW8ZkZNDHQJ6FgpwQ",
    "videos": 182,
    "views": 1045669467,
    "thumbnailUrl": "https://i.ytimg.com/vi/fOT0BUpITw8/hqdefault.jpg",
    "results": [
      {
        "type": "video",
        "videoId": "fOT0BUpITw8",
        "videoUrl": "https://www.youtube.com/watch?v=fOT0BUpITw8",
        "title": "BELLAKEO (Video Oficial) - Peso Pluma, Anitta",
        "channelId": "UCzrM_068Odho89mTRrrxqbA",
        "channelName": "Peso Pluma",
        "channelUrl": "https://www.youtube.com/channel/UCzrM_068Odho89mTRrrxqbA",
        "durationSeconds": 235,
        "views": 765000000,
        "thumbnailUrl": "https://i.ytimg.com/vi/fOT0BUpITw8/hqdefault.jpg",
        "isShort": false,
        "isLive": false,
        "publishedAt": "2024-10-05T09:08:51.000Z"
      }
    ],
    "cursor": "4qmFsgKBARIkVkxQTEZncXVMbkw1OWFsQ2xfMlRRdk9pRDVWZ20xaENhR1NJGjRDQUY2SGxCVU9rTkhVV2xGUlZrMVVXdGFRazFVWXpOT1JFazFUWHBSZVU…"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`type`	string	The kind of item: `video`.
`publishedAt`	string (ISO 8601)	Approximate. YouTube lists show only how long ago a video was published. YouTube video has the exact time.
`durationSeconds`	integer	The duration, in seconds.
`videos`	integer	The number of videos.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`cursor`	string	The pagination token from the previous response.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

YouTube transcript: Accepts videoUrl. Returns what a YouTube video says, from its captions.
YouTube video: Accepts videoUrl. Returns a video’s stats, description, chapters and most replayed moments.
YouTube comments: Accepts videoUrl. Returns a video’s comments, or the replies to one comment.
YouTube channel: Accepts channelUrl. Returns a channel’s profile and one tab of videos, shorts, live, playlists, podcasts or posts.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

playlistUrl

string

Link to the YouTube playlist, like https://www.youtube.com/playlist?list=PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI. Send this or playlistId.

playlistId

string

YouTube playlist id, like PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI. Send this or playlistUrl.

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

YouTube playlist API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods