A library to interact with the YouTube Music (InnerTube) api.
Note: This library is still in development, and is not ready for production use.
muse works on Deno, Node.js, the browser and any javascript environment that supports ES modules and fetch.
You can read the docs for more information about the usage of each function.
Don't forget to replace VERSION with the
latest version
import * as muse from "https://deno.land/x/muse@VERSION/mod.ts";
// you can also use the latest version (not recommended) with
// import * as muse from "https://deno.land/x/muse/mod.ts";
// you can also import directly from github
// import * as muse from "https://raw.githubusercontent.com/vixalien/muse/VERSION/mod.ts";
const search_results = await muse.search("drake");
const rickroll = await muse.get_song("dQw4w9WgXcQ");
You'll need to use a CDN that supports ES modules, such as esm.sh, jspm.io or skypack.dev.
You'll also need to use a proxy server to get around CORS errors. It's a good idea to self host the proxy server (cors-anywhere and deno_deploy_cors_proxy are good options).
import * as muse from "https://esm.sh/libmuse@VERSION";
// import * as muse from "https://jspm.dev/npm:libmuse@VERSION";
// import * as muse from "https://cdn.skypack.dev/libmuse@VERSION";
// setting up our proxy
muse.set_option("fetch", (url, options) => {
return fetch(`https://proxy.example.com/${url}`, options);
});
const search_results = await muse.search("top radio");
First install using your preferred package manager (npm, yarn, pnpm etc.)
npm install libmuse
Then use it in by importing libmuse. The Node version has the exact same
features as the Deno version.
import * as muse from "libmuse";
// commonjs: const muse = require("libmuse");
const artist = await muse.get_artist("UCvyjk7zKlaFyNIPZ-Pyvkng");
For the complete list of operations, see the docs.
Currently, muse supports oauth authentication by posing as the YouTube TV app.
Here's the flow:
import * as muse from "https://deno.land/x/muse@VERSION/mod.ts";
const auth = muse.get_option("auth");
muse.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
alert("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.detail;
resolve(auth_flow);
});
In the future, I plan to add support for other auth methods, such as cookies and Youtube TV login codes.
You can pass in a storage object to the client to persist the auth token.
import * as muse from "https://deno.land/x/muse@VERSION/mod.ts";
// you can use the "best" store, which is DenoFileStore if available, then LocalStorageStore, then MemoryStore
const client = muse.setup({ store: muse.get_best_store() });
// or you can use any of the built-in stores
const client = muse.setup({ store: new muse.DenoFileStore("/path/to/file.json") });
const client = muse.setup({ store: new muse.LocalStorageStore() });
const client = muse.setup({ store: new muse.MemoryStore() });
// or you can implement your own store
// by extending the Store abstract class
class MyStore extends muse.Store {
get<T>(key: string): T | null;
set(key: string, value: unknown): void;
delete(key: string): void;
}
// then use it accordingly
const client = muse.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:
muse.setup({ auth: { /* custom auth options */ } });
muse.setup({ store: /* custom store */ });
// the above will only use the custom store, and ignore the custom auth options
// if you need to configure options many times use `muse.set_option`
muse.set_option("store", /* custom store */)
I'm currently targetting to match the ytmusicapi's capabilities.
FAQs
A library to interact with the YouTube Music (InnerTube) api.
The npm package libmuse receives a total of 184 weekly downloads. As such, libmuse popularity was classified as not popular.
We found that libmuse demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Elastic’s return to open source with the AGPL license has been met with skepticism, as many developers see it as a strategic move rather than a genuine effort to restore user trust and freedoms.
Security News
A new "revival hijack" supply chain attack targets deleted Python packages, with an estimated 22K packages at risk. Socket can detect and block hijacked packages that have added malicious code.
Product
We're introducing a new Analytics feature in the Socket dashboard so you can view changes in your organization's and repositories' alerts over time.