A simple command utility to extract information from the YouTube API v3 for scientific purposes.
This Python based command line utility enables the easy extraction of information from the YouTube API (Version 3). Currently, it supports only a small subset of the API interface and focuses on extracting related videos from given starting points.
First, make sure you have a recent version of Python 3 installed.
Next, install yt-scraper by using pip:
sudo pip install yt-scraper
Update by adding the --upgrade flag:
sudo pip install --upgrade yt-scraper
Windows users may need to alter the command to:
py -m pip install --upgrade yt-scraper
Mac users may need to alter the command to:
python3 -m pip install --upgrade yt-scraper
In order to use this program, you will need an official YouTube API key.
You can obtain one from this page and
use it with the following examples by appending -k <KEY> to them.
Currently, yt-scraper has two commands: search and config
The first command is used to query the YouTube API, whereas the second is used to configure the default configuration.
The search command starts a video search from one or multiple given starting points. These could be multiple videos orginating from a search (using term), or a provided list of video ids (using input), or just one root video (using id or url).
For example, the following command will return the first video when one searches for cat.
$ yt-scraper search term 'cat'
[STATUS] Result:
Depth: 0, Rank: 0, ID: hY7m5jjJ9mM
Title: CATS will make you LAUGH YOUR HEAD OFF - Funny CAT compilation
Related Videos: []
One can also provide a video id or a video url as a starting point,
which is more interesting when combined with the --max-depth option:
$ yt-scraper search id '0A2R27kCeD4' --max-depth 2
Depth: 0, Rank: 0, ID: 0A2R27kCeD4
Title: 🤣 Funniest 🐶 Dogs and 😻 Cats - Awesome Funny Home Animal Videos 😇
Related Videos: ['pc8-8KfIW5c']
Depth: 1, Rank: 0, ID: pc8-8KfIW5c
Title: 🦁 Funniest Animals 🐼 - Try Not To Laugh 🤣 - Funny Domestic And Wild Animals' Life
Related Videos: ['OrJMUNEyZsE']
Depth: 2, Rank: 0, ID: OrJMUNEyZsE
Title: Funniest Videos for Pets to Watch Compilation | Funny Pet Videos
Related Videos: []
Additionally, one can specify the number of videos
that should be returned on each level by utilizing the --number option.
For instance, the following command returns two related videos
from a given video (specified by it's url) and
additionally one related video from each sibling:
$ yt-scraper search url 'https://www.youtube.com/watch?v=0A2R27kCeD4' --depth 1 --number 2 --number 1
[STATUS] Result:
Depth: 0, Rank: 0, ID: 0A2R27kCeD4
Title: 🤣 Funniest 🐶 Dogs and 😻 Cats - Awesome Funny Home Animal Videos 😇
Related Videos: ['pc8-8KfIW5c', 'tbyAuT50eu4']
Depth: 1, Rank: 0, ID: pc8-8KfIW5c
Title: 🦁 Funniest Animals 🐼 - Try Not To Laugh 🤣 - Funny Domestic And Wild Animals' Life
Related Videos: []
Depth: 1, Rank: 1, ID: tbyAuT50eu4
Title: 😁 Funniest 😻 Cats and 🐶 Dogs - Awesome Funny Pet Animals 😇
Related Videos: []
For the sake of brevity, you can shorten --number to -n and --depth to
-d.
There are even global commands, too! Global options are specified in front of the command and alter the behavior of all commands. This may not sound very meaningful to you given that there only two commands right now and you are right! But this is likely to change in the future.
For example, to see more output during the program execution,
specify --verbose or -v right after yt-scraper:
$ yt-scraper -v search id '0A2R27kCeD4' --max-depth 2
There are many more options that you can make use of. All of them are described in the Options section.
Sometimes you may find yourself struggling with all the possible options.
Fortunately, there is the config command for all the lazy typer out there.
Setting a particular default option like the output directory to ~/my_data is as easy
as typing
$ yt-scraper config set encoding utf-8
Forgetful? Just double-check by typing get instead of set:
$ yt-scraper config get encoding
[STATUS] The value of 'encoding' is set to 'utf-8'.
| Search options | Default | Description |
|---|---|---|
-n, --number | 1 | Number of the videos fetched per level (can be specified several times) |
-d, --max-depth | 0 | Number of recursion steps to perform. |
-k, --api-key | Required | The API key that should be used to query the YouTube API v3. |
-o, --output-dir | Optional | Path to the directory where output files are saved |
-f, --output-format | csv | Specifies the file format of output files. |
-N, --output-name | Optional | Specifies the file name or prefix of output files. |
-r, --region-code | de | Return only videos which are unrestricted in the given region. |
-l, --lang-code | de | Return videos mostly relevant to a specified language. |
-s, --safe-search | none | Filter sensitive or restricted videos. |
-e, --encoding | utf-8 | Transform fetched text to another encoding. |
-u, --unique | False | Do not process seen videos again |
| Global options | Default | Description |
|---|---|---|
-c, --config-path | System-specific | Specifies a configuration file. For details, see configuration. |
-v, --verbose | False | Shows more output during program execution. |
-V, --version | Optional | Shows the current program version and exits |
More information can be found by adding the --help option to commands or
reading the YouTube API manual.
Old-fashioned people, who do not like the config command,
can manually configure the program by editing the config.toml file.
It is secretly used and altered when using the config command.
Entered values are used in all future queries as long as
they are not overwritten by actual command line options.
For example, to always use the API key ABCDEFGH and a search depth of 3,
where on each level one video less is returned,
just create following configuration file:
config.toml
api_key = "ABCDEFGH"
number = [ 4, 3, 2, 1 ]
depth = 3
verbose = true
An example toml is included: config.toml
Then put this file in your standard configuration folder. Typically this folder can be found at the following location:
~/Library/Application Support/YouTube Scraper~/.config/youtube-scraperC:\Users\<user>\AppData\Roaming\YouTube ScraperIf the folder does not exist, you may need to create it first.
0.2.6
0.3.0
0.4.0
0.5.0
--depth renamed to --max-depth0.6.0
0.7.0
--version option--encoding option--export-name option--unique option0.8.0
--format sql SQLite exportconfig where command--include option--exclude optioninput argument to fileEvery of these features is going to be a minor patch:
If you come across any bugs or have a suggestion, please don't hesitate to file an issue.
Contributions in any form are welcomed. I will accept pull-requests if they extent yt-scraper's functionality.
To set up the development environment,
please install Poetry and run poetry install inside the project.
A test suite will be added soon.
In general, the contribution process is somewhat like this:
$ git clone https://github.com/rattletat/yt-scraper)$ git checkout -b feature/fooBar)$ git commit -am 'Add some fooBar')$ git push origin feature/fooBar)Michael Brauweiler
This plugin is free and unemcumbered software released into the public domain.
For more information, see the included UNLICENSE file.
FAQs
Command line utility querying the YouTube API v3.
We found that yt-scraper demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.