ytdl-core
Advanced tools
The ytdl-core npm package is a YouTube video downloader that allows you to download videos from YouTube and extract information about them. It is commonly used for creating custom video downloaders, streamers, and other applications that require access to YouTube content.
Download a YouTube Video
This feature allows you to download a YouTube video by providing its URL. The video is saved to a file on your local system.
const ytdl = require('ytdl-core');
const fs = require('fs');
const videoUrl = 'https://www.youtube.com/watch?v=VIDEO_ID';
const output = 'video.mp4';
ytdl(videoUrl)
.pipe(fs.createWriteStream(output))
.on('finish', () => {
console.log('Download completed!');
});Get Video Information
This feature allows you to retrieve detailed information about a YouTube video, such as its title, author, and view count.
const ytdl = require('ytdl-core');
const videoUrl = 'https://www.youtube.com/watch?v=VIDEO_ID';
ytdl.getInfo(videoUrl).then(info => {
console.log('Title:', info.videoDetails.title);
console.log('Author:', info.videoDetails.author.name);
console.log('Views:', info.videoDetails.viewCount);
}).catch(err => {
console.error('Error fetching video info:', err);
});Download Audio Only
This feature allows you to download only the audio stream of a YouTube video, which is useful for creating audio files from video content.
const ytdl = require('ytdl-core');
const fs = require('fs');
const videoUrl = 'https://www.youtube.com/watch?v=VIDEO_ID';
const output = 'audio.mp3';
ytdl(videoUrl, { filter: 'audioonly' })
.pipe(fs.createWriteStream(output))
.on('finish', () => {
console.log('Audio download completed!');
});youtube-dl is a command-line program to download videos from YouTube and other video sites. It is highly versatile and supports a wide range of video platforms. Compared to ytdl-core, youtube-dl is more feature-rich but requires a separate installation and is not a native Node.js package.
yt-dlp is a fork of youtube-dl with additional features and fixes. It offers similar functionality to youtube-dl but with more frequent updates and additional options. Like youtube-dl, it is not a native Node.js package and requires separate installation.
node-youtube-dl is a Node.js wrapper for youtube-dl. It allows you to use youtube-dl's functionality within a Node.js application. It provides similar capabilities to ytdl-core but relies on the external youtube-dl program.
Yet another YouTube downloading module. Written with only Javascript and a node-friendly streaming interface.
You can contact us for support on our chat server
const fs = require('fs');
const ytdl = require('ytdl-core');
// TypeScript: import ytdl from 'ytdl-core'; with --esModuleInterop
// TypeScript: import * as ytdl from 'ytdl-core'; with --allowSyntheticDefaultImports
// TypeScript: import ytdl = require('ytdl-core'); with neither of the above
ytdl('http://www.youtube.com/watch?v=aqz-KE-bpKQ')
.pipe(fs.createWriteStream('video.mp4'));
Attempts to download a video from the given url. Returns a readable stream. options can have the following, in addition to any getInfo() option and chooseFormat() option.
range - A byte range in the form {start: INT, end: INT} that specifies part of the file to download, ie {start: 10355705, end: 12452856}. Not supported on segmented (DASH MPD, m3u8) formats.
begin - What time in the video to begin. Supports formats 00:00:00.000, 0ms, 0s, 0m, 0h, or number of milliseconds. Example: 1:30, 05:10.123, 10m30s.
liveBuffer - How much time buffer to use for live videos in milliseconds. Default is 20000.highWaterMark - How much of the video download to buffer into memory. See node's docs for more. Defaults to 512KB.dlChunkSize - When the chosen format is video only or audio only, the download is separated into multiple chunks to avoid throttling. This option specifies the size of each chunk in bytes. Setting it to 0 disables chunking. Defaults to 10MB.ytdl.videoInfo - Info.ytdl.videoFormat - Video Format.Emitted when the video's info is fetched, along with the chosen format to download.
number - Chunk length in bytes or segment number.number - Total bytes or segments downloaded.number - Total bytes or segments.Emitted whenever a new chunk is received. Passes values describing the download progress.
All miniget events are forwarded and can be listened to from the returned stream.
Call to abort and stop downloading a video.
Use this if you only want to get metainfo from a video.
Gets metainfo from a video. Includes additional formats, and ready to download deciphered URL. This is what the ytdl() function uses internally.
options can have the following
requestOptions - Anything to merge into the request options which miniget is called with, such as headers.requestCallback - Provide a callback function that receives miniget request stream objects used while fetching metainfo.lang - The 2 character symbol of a language. Default is en.Once you have received metadata from a video with the ytdl.getInfo function, you may pass that information along with other options to this function.
Can be used if you'd like to choose a format yourself. Throws an Error if it fails to find any matching format.
options can have the following
quality - Video quality to download. Can be an itag value, a list of itag values, or one of these strings: highest/lowest/highestaudio/lowestaudio/highestvideo/lowestvideo. highestaudio/lowestaudio try to minimize video bitrate for equally good audio formats while highestvideo/lowestvideo try to minimize audio respectively. Defaults to highest, which prefers formats with both video and audio.
A typical video's formats will be sorted in the following way using quality: 'highest'
itag container quality codecs bitrate audio bitrate
18 mp4 360p avc1.42001E, mp4a.40.2 696.66KB 96KB
137 mp4 1080p avc1.640028 4.53MB
248 webm 1080p vp9 2.52MB
136 mp4 720p avc1.4d4016 2.2MB
247 webm 720p vp9 1.44MB
135 mp4 480p avc1.4d4014 1.1MB
134 mp4 360p avc1.4d401e 593.26KB
140 mp4 mp4a.40.2 128KB
format 18 at 360p will be chosen first since it's the highest quality format with both video and audio. If you'd like a higher quality format with both video and audio, see the section on handling separate streams.
filter - Used to filter the list of formats to choose from. Can be audioandvideo or videoandaudio to filter formats that contain both video and audio, video to filter for formats that contain video, or videoonly for formats that contain video and no additional audio track. Can also be audio or audioonly. You can give a filtering function that gets called with each format available. This function is given the format object as its first argument, and should return true if the format is preferable.
// Example with custom function.
ytdl(url, { filter: format => format.container === 'mp4' })
format - Primarily used to download specific video or audio streams. This can be a specific format object returned from getInfo.
filter and quality options since the format is explicitly provided.// Example of choosing a video format.
let info = await ytdl.getInfo(videoID);
let format = ytdl.chooseFormat(info.formats, { quality: '134' });
console.log('Format found!', format);
If you'd like to work with only some formats, you can use the filter option above.
// Example of filtering the formats to audio only.
let info = await ytdl.getInfo(videoID);
let audioFormats = ytdl.filterFormats(info.formats, 'audioonly');
console.log('Formats with only audio: ' + audioFormats.length);
Returns true if the given string satisfies YouTube's ID format.
Returns true if able to parse out a valid video ID.
Returns a video ID from a YouTube URL. Throws an Error if it fails to parse an ID.
Same as the above ytdl.getURLVideoID(), but can be called with the video ID directly, in which case it returns it. This is what ytdl uses internally.
Throws an Error if it fails to parse an ID.
The version string taken directly from the package.json.
ytdl cannot download videos that fall into the following
Generated download links are valid for 6 hours, and may only be downloadable from the same IP address.
Typically 1080p or better videos do not have audio encoded with it. The audio must be downloaded separately and merged via an encoding library. ffmpeg is the most widely used tool, with many Node.js modules available. Use the format objects returned from ytdl.getInfo to download specific streams to combine to fit your needs. Look at example/ffmpeg.js for an example on doing this.
YouTube updates their website all the time, it's not that rare for this to stop working. If it doesn't work for you and you're using the latest version, feel free to open up an issue. Make sure to check if there isn't one already with the same error.
Run the tests at test/irl-test.js to make sure this is really an issue with ytdl-core.
npm run test:irl
These tests are not mocked, they try to start downloading a few videos. If these fail, then it's time to debug. If the error you're getting is signature deciphering, check lib/sig.js. Otherwise, the error is likely within lib/info.js.
npm install ytdl-core@latest
Or for Yarn users:
yarn add ytdl-core@latest
Make sure you're installing the latest version of ytdl-core to keep up with the latest fixes.
If you're using a bot or app that uses ytdl-core such as ytdl-core-discord or discord-player, it may be dependent on an older version. To update its ytdl-core version, that library has to update its package.json file, you can't simply change the version on your project's package.json, the app will still use its own older version of ytdl-core.
Look in their repo to see if they already have an active pull request that updates ytdl-core. If they don't, open an issue asking them to update ytdl-core, or better yet, fork the project and submit a pull request with the updated version.
While you wait for the pull reques to merge, you can point to its branch in your package.json
"ytdl-core-discord": "amishshah/ytdl-core-discord#dependabot/npm_and_yarn/ytdl-core-2.0.1"
The issue of using an outdated version of ytdl-core became so prevalent, that ytdl-core now checks for updates at run time, and every 12 hours. If it finds an update, it will print a warning to the console advising you to update. Due to the nature of this library, it is important to always use the latest version as YouTube continues to update.
If you'd like to disable this update check, you can do so by providing the YTDL_NO_UPDATE env variable.
env YTDL_NO_UPDATE=1 node myapp.js
Tests are written with mocha
npm test
FAQs
YouTube video downloader in pure javascript.
The npm package ytdl-core receives a total of 34,384 weekly downloads. As such, ytdl-core popularity was classified as popular.
We found that ytdl-core demonstrated a not healthy version release cadence and project activity because the last version was released 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.