YOUTUBE API WRAPPER
OVERVIEW
This npm package, "youtube-datav3-api-wrapper" serves as a convenient and simplified interface for interacting with the YouTube Data V3 API. It offers functions to retrieve video information based on video ID, URL, title, and search queries.
INSTALLATION
npm i youtube-datav3-api-wrapper
USAGE
CONFIGURATION
Before using the package, ensure that you set up your YouTube Data API key. You can obtain one by following the instructions provided by Google here
Once you have your API key, create a .env file in the root of your project and add the following line: API_KEY=your_api_key_here
Example Usage
const youtubeApiWrapper = require("youtube-datav3-api-wrapper");
// Get video by ID const videoId = "videoId"; const videoById = await youtubeApiWrapper.getVideoById(videoId);
// Get video by URL const videoUrl = "https://www.youtube.com/watch?v=videoId"; const videoByUrl = await youtubeApiWrapper.getVideoByUrl(videoUrl);
// Get video by title const videoTitle = "Video Title"; const videoByTitle = await youtubeApiWrapper.getVideoByTitle(videoTitle);
// Search for videos const query = "Search Query"; const searchResults = await youtubeApiWrapper.searchVideo(query);
API METHODS
'getVideoById(videoId: string)'
Fetches video information by its YouTube video ID.
'getVideoByUrl(videoUrl: string)'
Fetches video information by a YouTube video URL.
'getVideoByTitle(videoTitle: string)'
Fetches video information by its title.
searchVideo(query: string, options: object)
Searches for videos based on a query and optional parameters.
TESTING
This package includes Jest tests to ensure its functionality. To run the tests, use the following npm command:
npm test
Dependencies
• axios: ^1.6.2
Development Dependencies
• jest: ^29.7.0
Author
Yeswanth Gontina
Version
1.0.1
Additional Notes
Feel free to reach out if you have any questions or need further assistance with using this package. Happy coding!