Giter Site home page Giter Site logo

renantatsuo / ytmusic-api Goto Github PK

View Code? Open in Web Editor NEW

This project forked from vladdenisov/ytmusic-api

1.0 1.0 0.0 793 KB

Unofficial YouTube Music API for NodeJS written in TypeScript

Home Page: https://vladdenisov.github.io/ytmusic-api/

License: MIT License

TypeScript 100.00%

ytmusic-api's Introduction

Unofficial YouTube Music API

GitHub last commit GitHub npm bundle size Snyk Vulnerabilities for GitHub Repo

Simple API Project for NodeJS written in TypeScript inspired by sigma67's python library

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development.

Prerequisites

  1. NodeJS 10+
  2. NPM
  3. Google Account

Installing

Using npm

NPM

Building it yourself

Clone github repo

  $ git clone https://github.com/vladdenisov/ytmusic-api 

Install dependencies

  $ npm i

Build it

  $ npm run build

You will see dist folder, where all built files are stored.

Usage

Getting the cookie

Get the auth cookie from requests to YTMusic in your browser:

  • Open YouTube Music in browser
  • Go to the developer tools (Ctrl-Shift-I) and find an authenticated POST request. You can filter for /browse to easily find a suitable request.
  • Copy cookie from Request Headers

Using in code

Import lib to your code:

  const { YTMUSIC } = require('ytmusic')
  // or if you build it yourself
  const { YTMUSIC } = require('path/to/ytmusic/dist/index.js')

Create new Instance of api with your cookie:

  const api = new YTMUSIC("cookie")

  // or if you want it to use not default account, specify userID (refer to docs to get it): 
  const api = new YTMUSIC("cookie", "userID")

Use it:

  const data = await api.getPlaylist('RDCLAK5uy_k1Wu8QbZASiGVqr1wmie9NIYo38aBqscQ')
  console.log(data.title)
  // { text: '80s Pop-Rock Anthems' }

Built With

  • TypeScript - JavaScript that scales.
  • node-fetch - A light-weight module that brings window.fetch to Node.js

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Just contribute <3

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

ytmusic-api's People

Contributors

vladdenisov avatar dhleong avatar deters avatar sourack avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.