Fork of ytmusic-api
Go to file
Zechariah e765141d60
🔀 Merge pull request #16 from sunwize/feat/artist@featureOn-similarArtists
Feature: Add featured on playlists and similar artists parsers
2023-10-04 10:21:24 +08:00
.github/workflows 🐛 add back publish step and update readme.md 2023-07-30 00:28:06 +08:00
docs 🔖 4.3.0 2023-08-08 05:19:05 +08:00
src fix: indent 2023-10-03 20:02:21 -04:00
.editorconfig 🚨 fix linting 2023-07-30 00:09:26 +08:00
.eslintrc.json 🚨 fix linting 2023-07-30 00:09:26 +08:00
.gitignore Migrated to using vuepress@2.0.0-beta 2022-03-29 16:45:00 +08:00
.npmignore 🚨 fix linting 2023-07-30 00:09:26 +08:00
.npmrc Added linebreak at the end of .npmrc 2022-03-30 23:39:31 +08:00
.prettierrc 🚨 fix linting 2023-07-30 00:09:26 +08:00
LICENSE Updated LICENSE 2022-03-28 03:31:43 +08:00
README.md 🐛 add back publish step and update readme.md 2023-07-30 00:28:06 +08:00
package.json 🔖 4.3.0 2023-08-08 05:19:05 +08:00
pnpm-lock.yaml Merge pull request #15 from zS1L3NT/dependabot/npm_and_yarn/json5-1.0.2 2023-08-03 17:35:30 +08:00
tsconfig.json Updated project configuration 2022-02-05 15:43:54 +08:00

README.md

YTMusic API

License Languages Top Language Commit Activity Last commit

YouTube Music API (Unofficial) is a YouTube Music data scraper. It comes with TypeScript support API for return types. The NPM package can be found here

Full documentation is available here.

Motivation

I used to use youtube-music-api as my youtube music api data scraper. I liked looking into the source code of how it works but it never made sense to me. I also didn't like that there were no TypeScript annotations for the return types of methods. Because of this, I decided to build my own version of a youtube music api with TypeScript annotations, testing and written in a way I can understand.

Features

  • TypeScript Support for data return types
    • Data from YouTube can be inconsistent but YTMusic API has been tested and the data matches the TypeScript types 95% of the time
  • Scrape information directly from YouTube Music API
    • Search Suggestions
    • Songs
    • Videos
    • Artists
    • Albums
    • Playlists

Credits

A lot of the credit should go to youtube-music-api. I build this package as a refactored and tested version of youtube-music-api with TypeScript annotations

Testing

YTMusic API's data return types are tested with Mocha. To run the tests, run the command

$ npm run test

Built with

  • NodeJS
    • TypeScript
      • @types/json-schema
      • @types/mocha
      • @types/node
      • @types/tough-cookie
      • @typescript-eslint/eslint-plugin
      • @typescript-eslint/parser
      • ts-node
      • typescript
    • Mocha
      • mocha
      • mocha.parallel
      • ts-mocha
    • VuePress
      • @vuepress/plugin-search
      • vuepress
    • ESLint
      • eslint
      • eslint-config-prettier
      • eslint-plugin-simple-import-sort
      • prettier
    • Miscellaneous
      • axios
      • tough-cookie
      • zod
      • zod-to-json-schema