get_video_id(url)

Given Youtube video URL, returns video id

Parameter :

• url : A youtube video watch URL as string. Supported URL format example :
  • https://www.youtube.com/watch?...
  • https://m.youtube.com/watch?...
  • https://youtu.be/...
  • https://www.youtube.com/embed/...
  • https://www.youtube-nocookie.com/embed/...

Returns :

• A string containing video id, or
• null

get_channel_id(url, offline, print_error)

Given Youtube channel, video or user URL, returns channel id

Parameters :

• url : A youtube video watch, channel or user URL as string. Supported URL format example :
  • https://www.youtube.com/channel/...
  • https://www.youtube.com/user/...
  • https://www.youtube.com/watch?...
  • https://m.youtube.com/watch?...
  • https://youtu.be/...
  • https://www.youtube.com/embed/...
  • https://www.youtube-nocookie.com/embed/...
• offline : An optional boolean argument to indicate whether or not to make HTTP request to get channel ID.
  • Default is false, which makes a single HTTP request to https://www.youtube.com/watch?... or https://www.youtube.com/user/... URL.
  • Setting it to true would return null to all URL other than those formatted like this https://www.youtube.com/channel/...
• print_error : An optional boolean argument to indicate whether or not to print any possible error message to console. Only useful for debugging. Default false.

Returns :

• A promise that resolves a string containing channel ID or,
• A promise that resolves null

is_valid_to_get_channel_id(url)

Given a URL, returns a Boolean indicating whether or not it is valid URL to get channel id

Parameter :

• url : Any type

Returns :

• True if url is one of the valid format to get channel ID information
  • See get_channel_id() above for URL formats that are considered valid
• False if url is not one of the valid format

get_playlist_id(url)

Given a playlist URL, returns the playlist's ID

Parameter :

• url : A youtube account user created playlist URL. Supported url format example:
  • https://www.youtube.com/playlist?list=...
  • https://m.youtube.com/playlist?list=...
  • https://www.youtube.com/watch?v=naHNhDHK4VU&list=...
  • https://m.youtube.com/watch?v=naHNhDHK4VU&list=...

Returns :

• A string containing playlist ID, or
• null

get_playlist_videos(url, offline, print_error)

Given playlist URL, returns an ordered array of playlist video IDs

Parameters :

• url : A youtube account user created or custom playlist URL. Supported url format example:
  • https://www.youtube.com/playlist?list=...
  • https://m.youtube.com/playlist?list=...
  • https://www.youtube.com/watch?v=naHNhDHK4VU&list=...
  • https://m.youtube.com/watch?v=naHNhDHK4VU&list=...
  • https://www.youtube.com/embed/naHNhDHK4VU?playlist=...,...,...
• offline : An optional boolean argument to indicate whether or not to make HTTP request to get channel ID.
  • Default is false (makes HTTP request). Note that only URLs formatted as https://www.youtube.com/embed/naHNhDHK4VU?playlist=...,...,... are parsable offline
• print_error : An optional boolean argument to indicate whether or not to print any possible error message to console. Only useful for debugging. Default false.

Returns :

• A promise that resolves a non-empty array of ordered video IDs of the playlist
  • The maximum length of this array is currently 100
• If invalid, error, or not parsable, returns a promise that resolves null

get_channel_id_and_name(url)

Given a video/video shortcut/embed/channel/user url, makes a single HTTP request and returns an object containing keys channel_id and channel_name with string values. On error or invalid url, returns null.

NOTE: this function is comparatively more susceptible to break on changes.

This software was not produced by or directly for YouTube, LLC and has no affiliation with the LLC. Use this software only at your own volition.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.