website·Indexed 29 days ago
https://popyt.brandonsbench.netA library for interacting with YouTube, featuring a YouTube class for searching channels and getting channel sections, as well as OAuth support via classes like OAuthChannels, OAuthVideos, OAuthComments, and OAuthPlaylists.
id (string): The unique ID of the channel.name (string): The name of the channel.about (string): The channel description.url (string): The channel URL.customUrl (string): The custom URL, if available.country (string): The country where the channel is based.language (string): The default upload language.dateCreated (Date): The date the channel was created.keywords (string[]): The channel's keywords.subCount (number): Number of subscribers. Returns -1 if the count is hidden.banner (string): URL to the channel banner image.profilePictures (object): Contains various thumbnail sizes (default, high, maxres, medium, standard).full (boolean): Indicates if this is a full channel object.data (any): The raw data of the channel.liveStatus (false | "live" | "upcoming"): Only set if the channel is a search result. Indicates if there is an ongoing or upcoming livestream.kids (object): Contains madeForKids and selfDeclaredMadeForKids booleans.localizations (object): A map of language codes to Schema$ChannelLocalization objects.These properties are only defined after their respective fetch methods are called:
playlists: A PaginatedResponse of Playlist objects (populated via fetchPlaylists()).subscriptions: A PaginatedResponse of Subscription objects (populated via fetchSubscriptions()).sections: An array of ChannelSection objects (populated via fetchSections()).featuredChannels (string[]): URLs of featured channels (Note: this property may be broken for some channels).The Video class provides extensive metadata about a YouTube video. Key properties include:
id (string), shortUrl (string, e.g., https://youtu.be/id).description (string), tags (string[]), category (string), license ("creativeCommon" | "youtube").datePublished (Date), dateRecorded (Date), minutes (number), seconds (number).likes (number), dislikes (number), commentCount (number).liveStatus (false | "live" | "upcoming"), private (boolean - indicates if the video could be private).channel object containing id and name.kids object containing madeForKids and selfDeclaredMadeForKids (booleans).localizations object mapping language strings to localized data.data (any) contains the raw video data.full (boolean) indicates if this is a full video object.OAuth class is used to access all YouTube methods requiring an OAuth access token. It is typically accessed via YouTube.oauth.// Constructor signature
new OAuth(youtube, request, upload);fetchVideos() on a playlist object to retrieve its videos. Once fetched, videos are available both as the return value of the method and via the playlist.videos array.const videos = await playlist.fetchVideos()
console.log(`First video: ${playlist.videos[0].title}`)
console.log(`Last video: ${videos[videos.length - 1].title}`)Captions and comments are not available by default upon instantiation. They must be explicitly fetched using the class methods:
captions property (Caption[]) only after calling Video.fetchCaptions().comments property (PaginatedResponse<Comment>) only after calling Video.fetchComments().VideoRating instance by providing the associated YouTube client object, the raw rating data (Schema$VideoRating), and an optional boolean indicating if it is a full object.const videoRating = new VideoRating(youtubeClient, ratingData, true);YouTube class is the primary entry point for interacting with the YouTube API. It can be configured with an API key for general data access or an OAuth access token for authenticated methods.const yt = new YouTube(
'YOUR_API_KEY',
'YOUR_ACCESS_TOKEN',
{ /* caching options */ },
'en_US',
'US'
);commentCount), you must call the .fetch() method on the individual video object. The video.full property indicates whether the full data has been loaded.const video = playlist.videos[0]
console.log(video.full) // false
console.log(video.commentCount) // undefined
await video.fetch()
console.log(video.full) // true
console.log(video.commentCount) // the number of comments on the videonpm install popytnpm install popytOAuthVideos class is used to perform authenticated actions on YouTube videos. It requires an OAuth instance and request handlers for standard requests and uploads.const oauthVideos = new OAuthVideos(oauth, request, upload);