Skip to main content
POST
Scrape a YouTube playlist and its videos
Scrape a YouTube playlist and 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.

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.
For every field, see the response schema on this page.

Optional parameters

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.

Authorizations

Authorization
string
header
required

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

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

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
creditsUsed
integer
required
requestId
string
required