{"_id":"@decoded-satapathy/ytmusic-api","_rev":"1-976a7e6e7bf1e06bae1a2b9019df9293","name":"@decoded-satapathy/ytmusic-api","dist-tags":{"latest":"5.2.3"},"versions":{"5.2.2":{"name":"@decoded-satapathy/ytmusic-api","version":"5.2.2","keywords":["youtube","music","api"],"author":{"url":"http://www.zectan.com","name":"zS1L3NT","email":"dev@zectan.com"},"license":"GPL-3.0","_id":"@decoded-satapathy/ytmusic-api@5.2.2","maintainers":[{"name":"decoded-satapathy","email":"omsatapathy05@gmail.com"}],"homepage":"https://github.com/zS1L3NT/ts-npm-ytmusic-api#readme","bugs":{"url":"https://github.com/zS1L3NT/ts-npm-ytmusic-api/issues"},"dist":{"shasum":"c6b97c484ef47c0b480cbe13e1cba26ff964c3bb","tarball":"https://registry.npmjs.org/@decoded-satapathy/ytmusic-api/-/ytmusic-api-5.2.2.tgz","fileCount":9,"integrity":"sha512-ywEhN0mnflL+Zr98Utnri8SPOZfEGFhBpa6TRHR7gKJmq0V2Bt0BhaQyl2s9N4dnTyoQ03nRzOkgZjvSfL3DOA==","signatures":[{"sig":"MEYCIQC887ISXbo6X2pmC+2IUYdJc62tD3VCN7nROYpjPiZhGwIhAL4cq5JTYKIYvZpyiJ6LRp+1/P9hHao+UrtRsXG88twA","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":559747},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"gitHead":"ab73d68c28c63484797ee215462e6500b437e07f","scripts":{"lint":"tsc --noEmit ; bunx @biomejs/biome check --write","build":"tsup src/index.ts"},"_npmUser":{"name":"decoded-satapathy","email":"omsatapathy05@gmail.com"},"repository":{"url":"git+https://github.com/zS1L3NT/ts-npm-ytmusic-api.git","type":"git"},"_npmVersion":"10.8.1","description":"YouTube Music API","directories":{},"_nodeVersion":"22.3.0","dependencies":{"zod":"^3.23.8","axios":"^1.7.2","tough-cookie":"^4.1.4","@biomejs/biome":"1.8.3"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.1.0","bun-types":"^1.1.18","typescript":"5.1","zod-to-json-schema":"^3.23.1","@types/tough-cookie":"^4.0.5"},"_npmOperationalInternal":{"tmp":"tmp/ytmusic-api_5.2.2_1724184759450_0.13820371540771403","host":"s3://npm-registry-packages"}},"5.2.3":{"name":"@decoded-satapathy/ytmusic-api","version":"5.2.3","description":"YouTube Music API","main":"./dist/index.js","module":"./dist/index.mjs","types":"./dist/index.d.ts","author":{"name":"zS1L3NT","email":"dev@zectan.com","url":"http://www.zectan.com"},"license":"GPL-3.0","repository":{"type":"git","url":"git+https://github.com/zS1L3NT/ts-npm-ytmusic-api.git"},"exports":{".":{"require":"./dist/index.js","import":"./dist/index.mjs","types":"./dist/index.d.ts"}},"scripts":{"build":"tsup src/index.ts","lint":"tsc --noEmit ; bunx @biomejs/biome check --write"},"dependencies":{"@biomejs/biome":"1.8.3","axios":"^1.7.2","tough-cookie":"^4.1.4","zod":"^3.23.8"},"devDependencies":{"@types/tough-cookie":"^4.0.5","bun-types":"^1.1.18","tsup":"^8.1.0","typescript":"5.1","zod-to-json-schema":"^3.23.1"},"keywords":["youtube","music","api"],"_id":"@decoded-satapathy/ytmusic-api@5.2.3","gitHead":"ab73d68c28c63484797ee215462e6500b437e07f","bugs":{"url":"https://github.com/zS1L3NT/ts-npm-ytmusic-api/issues"},"homepage":"https://github.com/zS1L3NT/ts-npm-ytmusic-api#readme","_nodeVersion":"22.3.0","_npmVersion":"10.8.1","dist":{"integrity":"sha512-V9rccBuyx4Dk4cy6AM1H5ifVcnaHKJTdasy9ELLHmk2Vc7rWPjrty67Hh87/2gSDm2mSO6kKKKVmvAkLyNux6Q==","shasum":"d8c80ed970ef36e36f4f735a172e693ee21c91c2","tarball":"https://registry.npmjs.org/@decoded-satapathy/ytmusic-api/-/ytmusic-api-5.2.3.tgz","fileCount":9,"unpackedSize":559759,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCBGm5XX/kkuRq4zxNrspvM+SLJQEu3wkaYvFXBhDL6swIgZITrSCEBkX/ftscMqsF/tAyltfjXGbnfmC1BYnZ+i58="}]},"_npmUser":{"name":"decoded-satapathy","email":"omsatapathy05@gmail.com"},"directories":{},"maintainers":[{"name":"decoded-satapathy","email":"omsatapathy05@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ytmusic-api_5.2.3_1724184908330_0.28685854172773007"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-20T20:12:39.355Z","modified":"2024-08-20T20:15:08.666Z","5.2.2":"2024-08-20T20:12:39.760Z","5.2.3":"2024-08-20T20:15:08.499Z"},"bugs":{"url":"https://github.com/zS1L3NT/ts-npm-ytmusic-api/issues"},"author":{"name":"zS1L3NT","email":"dev@zectan.com","url":"http://www.zectan.com"},"license":"GPL-3.0","homepage":"https://github.com/zS1L3NT/ts-npm-ytmusic-api#readme","keywords":["youtube","music","api"],"repository":{"type":"git","url":"git+https://github.com/zS1L3NT/ts-npm-ytmusic-api.git"},"description":"YouTube Music API","maintainers":[{"name":"decoded-satapathy","email":"omsatapathy05@gmail.com"}],"readme":"# YTMusic API\n\n![License](https://img.shields.io/github/license/zS1L3NT/ts-npm-ytmusic-api?style=for-the-badge) ![Languages](https://img.shields.io/github/languages/count/zS1L3NT/ts-npm-ytmusic-api?style=for-the-badge) ![Top Language](https://img.shields.io/github/languages/top/zS1L3NT/ts-npm-ytmusic-api?style=for-the-badge) ![Commit Activity](https://img.shields.io/github/commit-activity/y/zS1L3NT/ts-npm-ytmusic-api?style=for-the-badge) ![Last commit](https://img.shields.io/github/last-commit/zS1L3NT/ts-npm-ytmusic-api?style=for-the-badge)\n\nYouTube 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](https://npmjs.com/package/ytmusic-api)\n\n## Motivation\n\nI used to use [youtube-music-api](https://npmjs.com/package/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.\nBecause 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.\n\n## Features\n\n-   TypeScript Support for data return types\n    -   Data from YouTube can be inconsistent but YTMusic API has been tested and the data matches the TypeScript types 95% of the time\n-   Scrape information directly from YouTube Music API\n    -   Search Suggestions\n    -   Songs\n    -   Videos\n    -   Artists\n    -   Albums\n    -   Playlists\n    -   Lyrics\n\n## Usage\n\n```js\nimport YTMusic from \"ytmusic-api\"\n\nconst ytmusic = new YTMusic()\nawait ytmusic.initialize(/* Optional: Custom cookies */)\n\nytmusic.search(\"Never gonna give you up\").then(songs => {\n\tconsole.log(songs)\n})\n```\n\n## Credits\n\nA lot of the credit should go to [youtube-music-api](https://npmjs.com/package/youtube-music-api). I build this package as a refactored and tested version of youtube-music-api with TypeScript annotations\n\n## Testing\n\nYTMusic API's data return types are tested with Bun Test. To run the tests, run the command\n\n```\n$ bun test\n```\n\n## Built with\n\n-   NodeJS\n    -   TypeScript\n        -   [![@types/tough-cookie](https://img.shields.io/badge/%40types%2Ftough--cookie-%5E4.0.5-red?style=flat-square)](https://npmjs.com/package/@types/tough-cookie/v/4.0.5)\n        -   [![bun-types](https://img.shields.io/badge/bun--types-%5E1.1.18-red?style=flat-square)](https://npmjs.com/package/bun-types/v/1.1.18)\n        -   [![tsup](https://img.shields.io/badge/tsup-%5E8.1.0-red?style=flat-square)](https://npmjs.com/package/tsup/v/8.1.0)\n        -   [![typescript](https://img.shields.io/badge/typescript-5.1-red?style=flat-square)](https://npmjs.com/package/typescript/v/5.1)\n    -   Miscellaneous\n        -   [![@biomejs/biome](https://img.shields.io/badge/%40biomejs%2Fbiome-1.8.3-red?style=flat-square)](https://npmjs.com/package/@biomejs/biome/v/1.8.3)\n        -   [![axios](https://img.shields.io/badge/axios-%5E1.7.2-red?style=flat-square)](https://npmjs.com/package/axios/v/1.7.2)\n        -   [![tough-cookie](https://img.shields.io/badge/tough--cookie-%5E4.1.4-red?style=flat-square)](https://npmjs.com/package/tough-cookie/v/4.1.4)\n        -   [![zod](https://img.shields.io/badge/zod-%5E3.23.8-red?style=flat-square)](https://npmjs.com/package/zod/v/3.23.8)\n        -   [![zod-to-json-schema](https://img.shields.io/badge/zod--to--json--schema-%5E3.23.1-red?style=flat-square)](https://npmjs.com/package/zod-to-json-schema/v/3.23.1)","readmeFilename":"README.md"}