Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codedotjs/youtube-playlist
:snowflake: Extract links, ids, and names from a youtube playlist
https://github.com/codedotjs/youtube-playlist
api ids links names nodejs npm-package scraper urls youtube youtube-api
Last synced: about 2 months ago
JSON representation
:snowflake: Extract links, ids, and names from a youtube playlist
- Host: GitHub
- URL: https://github.com/codedotjs/youtube-playlist
- Owner: CodeDotJS
- License: mit
- Created: 2018-05-11T08:37:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T16:09:54.000Z (over 4 years ago)
- Last Synced: 2024-12-11T21:11:50.658Z (about 2 months ago)
- Topics: api, ids, links, names, nodejs, npm-package, scraper, urls, youtube, youtube-api
- Language: JavaScript
- Homepage:
- Size: 392 KB
- Stars: 90
- Watchers: 8
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Extract links, ids, durations and names from a youtube playlist
## Install
```
$ npm install --save youtube-playlist
```
## Usage
- __`urls`__
```js
const ytlist = require('youtube-playlist');
const url = 'https://www.youtube.com/playlist?list=PLWKjhJtqVAbnZtkAI3BqcYxKnfWn_C704';
ytlist(url, 'url').then(res => {
console.log(res);
/* Object
{ data:
{ playlist:
[ 'https://youtube.com/watch?v=bgU7FeiWKzc',
'https://youtube.com/watch?v=3PUVr8jFMGg',
'https://youtube.com/watch?v=3pXVHRT-amw',
'https://youtube.com/watch?v=KOVc5o5kURE' ] } }
*/
});
// or
ytlist(url, 'url').then(res => {
console.log(res.data.playlist);
/* Array
[ 'https://youtube.com/watch?v=bgU7FeiWKzc',
'https://youtube.com/watch?v=3PUVr8jFMGg',
'https://youtube.com/watch?v=3pXVHRT-amw',
'https://youtube.com/watch?v=KOVc5o5kURE' ]
*/
});
```
- __`names`__
```js
ytlist(url, 'name').then(res => {
console.log(res);
/*
{ data:
{ playlist:
[ 'Singleton Design Pattern - Beau teaches JavaScript',
'Observer Design Pattern - Beau teaches JavaScript',
'Module Design Pattern - Beau teaches JavaScript',
'Mediator Design Pattern - Beau teaches JavaScript' ] } }
*/
});
```
- __`ids`__
```js
ytlist(url, 'id').then(res => {
console.log(res);
// => { data: { playlist: [ 'bgU7FeiWKzc', '3PUVr8jFMGg', '3pXVHRT-amw', 'KOVc5o5kURE' ] } }
})
```
- __`durations`__
```js
ytlist(url, 'duration').then(res => {
console.log(res);
// => { data: { playlist: [ 291, 237, 164, 309 ] } }
})
```
- __`multiple details`__
```js
ytlist(url).then(res => {
console.log(res.data);
// = [{}]
});
// or
ytlist(url, ['id', 'name', 'url']).then(res => {
console.log(res.data);
/* Array
[ { id: 'bgU7FeiWKzc',
name: 'Singleton Design Pattern - Beau teaches JavaScript',
url: 'https://youtube.com/watch?v=bgU7FeiWKzc',
isPrivate: false },
{ id: '3PUVr8jFMGg',
name: 'Observer Design Pattern - Beau teaches JavaScript',
url: 'https://youtube.com/watch?v=3PUVr8jFMGg',
isPrivate: false },
{ id: '3pXVHRT-amw',
name: 'Module Design Pattern - Beau teaches JavaScript',
url: 'https://youtube.com/watch?v=3pXVHRT-amw',
isPrivate: false },
{ id: 'KOVc5o5kURE',
name: 'Mediator Design Pattern - Beau teaches JavaScript',
url: 'https://youtube.com/watch?v=KOVc5o5kURE',
isPrivate: false } ]
*/
});
```
__Notice__: In `multiple details` - another prop will be added. `isPrivate` will be true when the video is private (for not loggedin user).
## API
```js
ytlist(url, opts)
```
#### `opts`
- __`id`__ `:` `returns only ids of all the videos present in a playlist`
- __`url`__ `:` `returns only urls of all the videos present in a playlist`
- __`name`__ `:` `return only name of the videos present in a playlist`
- __`duration`__ `:` `return only duration (in seconds) of the videos present in a playlist`
- Passing `opts` either as __`url`__ or an array of options __`['id', 'name', 'url', 'duration']`__ returns all the details.
__Type of__
- __`url`__ `:` __`string`__
- __`opts`__ `:` __`string`__ or __`array`__
#### NOTE
- This `api` already supports `url-redirection`, so you are free to use the shortened url.
- For data extraction, you can either choose -
- __`playlist url`__
- __`url of the content from playlist`__ __[`#1`](https://github.com/CodeDotJS/youtube-playlist/issues/1)__
## Related
- __[`Pufetch`](https://github.com/CodeDotJS/pufetch)__ `:` `The best youtube playlist url scrapper and exporter!`
## License
MIT © [Rishi Giri](http://rishigiri.ml)