Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timeforaninja/node-ytpl
Anonymous YouTube playlist resolver.
https://github.com/timeforaninja/node-ytpl
deprecated deprecated-repository javascript nodejs playlist youtube
Last synced: about 2 months ago
JSON representation
Anonymous YouTube playlist resolver.
- Host: GitHub
- URL: https://github.com/timeforaninja/node-ytpl
- Owner: TimeForANinja
- License: mit
- Archived: true
- Created: 2017-02-23T14:24:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T00:55:42.000Z (10 months ago)
- Last Synced: 2024-09-24T15:31:49.553Z (about 2 months ago)
- Topics: deprecated, deprecated-repository, javascript, nodejs, playlist, youtube
- Language: HTML
- Homepage:
- Size: 1010 KB
- Stars: 202
- Watchers: 6
- Forks: 48
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED
This repo is no longer supported, please consider using the official api instead.
# node-ytpl
[](https://www.npmjs.com/package/ytpl)
[](https://www.npmjs.com/package/ytpl)
[](https://codecov.io/gh/timeforaninja/node-ytpl)
[](https://snyk.io/test/github/timeforaninja/node-ytpl)
[](https://discord.gg/V3vSCs7)
Simple js only package to resolve YouTube Playlists.
Does not require any login or Google-API-Key.
# Support
You can contact us for support on our [chat server](https://discord.gg/V3vSCs7)
# Usage
```js
const ytpl = require('ytpl');
const playlist = await ytpl('UU_aEa8K-EOJ3D6gOs7HcyNg');
```
# API
### ytpl(id, [options])
Attempts to resolve the given playlist id
* `id`
* id of the yt-playlist
* or a playlist url
* or a user url (resolves to uploaded playlist)
* or a channel url (resolves to uploaded playlist)
* `options`
* object with options
* possible settings:
* gl[String] -> 2-Digit Code of a Country, defaults to `US` - Allows for localisation of the request
* hl[String] -> 2-Digit Code for a Language, defaults to `en` - Allows for localisation of the request
* limit[Number] -> limits the pulled items, defaults to 100, set to Infinity to get the whole playlist - numbers <1 result in the default being used
* pages[Number] -> limits the pulled pages, pages contain 100 items, set to Infinity to get the whole playlist - numbers <1 result in the default limit being used - overwrites limit
* requestOptions[Object] -> Additional parameters to passed to [miniget](https://github.com/fent/node-miniget), which is used to do the https requests
* returns a Promise
* [Example response](https://github.com/timeforaninja/node-ytpl/blob/master/example/example_output.txt)
### ytpl.continueReq(continuationData)
Continues a previous request by pulling yet another page.
The previous request had to be done using `pages` limitation.
#### Usage
```js
const ytpl = require('ytpl');
const firstResultBatch = await ytpl('UU_aEa8K-EOJ3D6gOs7HcyNg', { pages: 1 });
const secondResultBatch = ytpl.continueReq(firstResultBatch.continuation);
const thirdResultBatch = ytpl.continueReq(secondResultBatch.continuation);
// You can now use the .items property of all result batches e.g.:
console.log(firstResultBatch.items);
console.log(secondResultBatch.items);
console.log(thirdResultBatch.items);
```
* returns a Promise resolving into `{ continuation, items }`
### ytpl.validateID(string)
Returns true if able to parse out a (formally) valid playlist ID.
### ytpl.getPlaylistID(string)
Returns a playlist ID from a YouTube URL. Can be called with the playlist ID directly, in which case it just resolves.
* returns a promise resolving into a string containing the id
# Related / Works well with
* [node-ytdl-core](https://github.com/fent/node-ytdl-core)
* [node-ytsr](https://github.com/TimeForANinja/node-ytsr)
# Install
npm install --save ytpl
# License
MIT