Skip to main content
Deno 2 is finally here 🎉️
Learn more

muse

A library to interact with the YouTube Music (InnerTube) api.

Note: This library is still in development, and is not ready for production use.

Usage

Deno

import { search, get_song } from "https://deno.land/x/muse/mod.ts";

search("drake")
  .then((data) => {
    console.log("search results", data);
  });

get_song("dQw4w9WgXcQ")
  .then((data) => {
    console.log("song", data);
  });

Node

const { get_artist } = require("libmuse");

get_artist("UCvyjk7zKlaFyNIPZ-Pyvkng")
  .then((data) => {
    console.log("artist", data);
  });

For the complete list of operations, see the docs.

Auth

Currently, muse supports oauth authentication by posing as the YouTube TV app.

Here’s the flow:

  1. Get a login code
  2. Go to the given login url, and type in the login code on a device that is logged into a google account
  3. Get the OAuth token & refresh tokens
import { get_option, setup } from "https://deno.land/x/muse/mod.ts";
import { RequiresLoginEvent } from "https://deno.land/x/muse/auth.ts";

const auth = get_option("auth");

setup({
  // make sure to persist the token
  store: new DenoFileStore("store/muse-store.json"),
  debug: true,
});

// this is the authentication flow
const auth_flow = async () => {
  if (auth.has_token()) return;
  console.log("Getting login code...");

  const loginCode = await auth.get_login_code();

  console.log(
    `Go to ${loginCode.verification_url} and enter the code: ${loginCode.user_code}`,
  );

  // not necessary, but saves some requests
  confirm("Press enter when you have logged in");

  console.log("Loading token...");

  await auth.load_token_with_code(
    loginCode.device_code,
    loginCode.interval,
  );

  console.log("Logged in!", auth._token);
};

// listen to the `requires-login` event, then resolve pass on a function that
// returns a promise that will resolve when the auth flow is complete
auth.addEventListener("requires-login", (event) => {
  const resolve = (event as RequiresLoginEvent).detail;

  resolve(auth_flow);
});

In the future, I plan to add support for other auth methods, such as cookies and Youtube TV login codes.

Storage

You can pass in a storage object to the client to persist the auth token.

import { setup } from "https://deno.land/x/muse/mod.ts";
import {
  DenoFileStore,
  get_default_store,
  LocalStorageStore,
  MemoryStore,
  Store,
} from "https://deno.land/x/muse/store.ts";

// you can use the default store, which is DenoFileStore if available, then LocalStorageStore, then MemoryStore
const client = setup({ store: get_default_store() });

// or you can use any of the built-in stores
const client = setup({ store: new DenoFileStore("/path/to/file.json") });
const client = setup({ store: new LocalStorageStore() });
const client = setup({ store: new MemoryStore() });

// or you can implement your own store
// by extending the Store abstract class
class MyStore extends Store {
  get<T>(key: string): T | null;
  set(key: string, value: unknown): void;
  delete(key: string): void;
}

// then use it accordingly
const client = setup({ store: new MyStore() });

// Do note that setup() can be called multiple times, but it's not recommended. 
// this is because setup overrides the global store, so if you call setup()
// multiple times, other options set before will be ignored. example:

setup({ auth: { /* custom auth options */ } });
setup({ store: /* custom store */ });

// the above will only use the custom store, and ignore the custom auth options

Operations

I’m currently targetting to match the ytmusicapi’s capabilities.

  • search
  • search suggestions

browsing

  • home
  • get artist
  • get artist albums
  • get album
  • get album browse id
  • get user
  • get user playlists
  • get song
  • get song related
  • get lyrics
  • get tasteprofile
  • set tasteprofile

explore

  • get explore
  • get mood categories
  • get mood playlists
  • get charts
  • get new releases

watch

  • get queue get watch playlist

library

  • get library
  • get library playlists
  • get library songs
  • get library albums
  • get library artists
  • get library subscriptions
  • get liked songs
  • get history
  • add history item
  • remove history items
  • rate song
  • edit song library status
  • rate playlist
  • subscribe artists
  • unsubscribe artists

playlists

  • get playlist
  • create playlist
  • edit playlist
  • delete playlist
  • add playlist items
  • remove playlist items

uploads

  • get library upload songs
  • get library upload artists
  • get library upload albums
  • get library upload artist
  • get library upload album
  • upload song
  • delete upload entity

Acknowledgements

  • ytmusicapi - The inspiration for this library
  • Youtube Internal Clients - The source of the client names and versions
  • many random gists and blog posts whose links I’ve lost