Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timeforaninja/node-ytsr
Do anonymous YouTube search requests.
https://github.com/timeforaninja/node-ytsr
deprecated deprecated-repository javascript nodejs search youtube
Last synced: 3 months ago
JSON representation
Do anonymous YouTube search requests.
- Host: GitHub
- URL: https://github.com/timeforaninja/node-ytsr
- Owner: TimeForANinja
- License: mit
- Archived: true
- Created: 2017-03-04T16:45:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T00:55:44.000Z (almost 1 year ago)
- Last Synced: 2024-04-28T04:37:32.363Z (9 months ago)
- Topics: deprecated, deprecated-repository, javascript, nodejs, search, youtube
- Language: HTML
- Homepage:
- Size: 1.13 MB
- Stars: 283
- Watchers: 9
- Forks: 69
- Open Issues: 25
-
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-ytsr
[](https://www.npmjs.com/package/ytsr)
[](https://www.npmjs.com/package/ytsr)
[](https://codecov.io/gh/timeforaninja/node-ytsr)
[](https://snyk.io/test/github/timeforaninja/node-ytsr)
[](https://discord.gg/V3vSCs7)
Simple js only package to search for Youtube for Videos, Playlists and many more.
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 ytsr = require('ytsr');
const searchResults = await ytsr('github');
```
# API
### ytsr(searchString, [options])
Searches for the given string
* `searchString`
* search string or url (from getFilters) to search from
* `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
* safeSearch[Boolean] -> pull items in youtube restriction mode.
* limit[integer] -> limits the pulled items, defaults to 100, set to Infinity to get the whole list of search results - numbers <1 result in the default being used
* pages[Number] -> limits the pulled pages, pages contain 20-30 items, set to Infinity to get the whole list of search results - 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-ytsr/blob/master/example/example_search_output.txt)
### ytsr.getFilters(searchString, options)
Pulls avaible filters for the given string or link
#### Usage
```js
const ytsr = require('ytsr');
const filters1 = await ytsr.getFilters('github');
const filter1 = filters1.get('Type').get('Video');
const filters2 = await ytsr.getFilters(filter1.url);
const filter2 = filters2.get('Features').get('Live');
const options = {
pages: 2,
}
const searchResults = await ytsr(filter2.url, options);
```
* `searchString`
* string to search for
* or previously optained filter ref
* `options`
* 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
* 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 resulting in a `Map>`
* [Example response](https://github.com/timeforaninja/node-ytsr/blob/master/example/example_filters_output.txt)
### ytsr.continueReq(continuationData)
Continues a previous request by pulling yet another page.
The previous request had to be done using `pages` limitation.
#### Usage
```js
const ytsr = require('ytsr');
const firstResultBatch = await ytsr('github', { pages: 1 });
const secondResultBatch = ytsr.continueReq(firstResultBatch.continuation);
const thirdResultBatch = ytsr.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 }`
# Related / Works well with
* [node-ytdl-core](https://github.com/fent/node-ytdl-core)
* [node-ytpl](https://github.com/TimeForANinja/node-ytpl)
# Install
npm install --save ytsr
# License
MIT