akshandrasingh / youtube-downloader Goto Github PK

This documentation provides a guide on how to use the YouTube Downloader API, a service that allows you to download YouTube videos by providing their URLs. The API is built using Node.js, Express, and the ytdl-core library.

1. Introduction
2. Prerequisites
3. Installation
4. Usage
5. Response Format
6. Error Handling
7. Conclusion

The YouTube Downloader API allows users to download YouTube videos by sending a POST request with the video URL. The API retrieves video information using the ytdl-core library and then downloads the video in the desired quality.

Before using the YouTube Downloader API, make sure you have the following prerequisites:

• Node.js (Recommended version: 14.0.0 or higher)
• npm (Node Package Manager)

To install and set up the YouTube Downloader API:

1. Clone the repository:

   git clone https://github.com/ishansingh1010/Youtube-Downloader
   

2. Install dependencies:

   npm install
   

3. Start the server:

   node app.js
   

To use the YouTube Downloader API:

1. Open Postman or your preferred API testing tool.

2. Create a POST request to the API endpoint:

   POST http://localhost:7000/videoDownloader
   

3. Set the request body to JSON format:

   {
     "videoUrl": "https://www.youtube.com/watch?v=YOUR_VIDEO_ID"
   }

4. Send the request. If the API is hosted online, replace http://localhost:7000 with the actual deployment URL.

Upon successful download, the API will respond with a JSON object:

• success (boolean): Indicates whether the download was successful.
• message (string): A message indicating the result of the download.
• videoTitle (string): The title of the downloaded video.

If an error occurs, the API response will contain an error message:

• success (boolean): Indicates whether an error occurred.
• message (string): A message indicating that an error occurred.
• error (string): A detailed error message describing the issue.

The YouTube Downloader API provides a simple way to download YouTube videos programmatically. By following this documentation, you can set up the API, make requests, and retrieve video files efficiently. Feel free to explore and integrate the API into your projects, and if you have any questions or issues, please contact on [email protected]