atexovi-ytmusic-api

Description

This is a fork of ytmusic-api with modifications for Node.js compatibility and Termux optimization.

Changes from Original

• Migrated from Bun to Node.js
• Removed bun-types dependencies
• Updated build configuration for Node.js
• Optimized for Termux and Android environments

Features

• TypeScript Support
• Search Suggestions
• Songs
• Videos
• Artists
• Albums
• Playlists
• Lyrics
• Upcoming Songs

Installation

npm install atexovi-ytmusic-api

Usage

CommonJS (Node.js)

const YTMusicModule = require('atexovi-ytmusic-api');
const YTMusic = YTMusicModule.default;

async function main() {
    const ytmusic = new YTMusic();
    await ytmusic.initialize();
    
    const songs = await ytmusic.search("Never gonna give you up");
    console.log(songs);
}

main();

ES Modules

import YTMusic from 'atexovi-ytmusic-api';

const ytmusic = new YTMusic();
await ytmusic.initialize();

const songs = await ytmusic.search("Never gonna give you up");
console.log(songs);

API Methods

| Method | Description | |--------|-------------| | search(query) | Search for songs, videos, artists | | getSearchSuggestions(query) | Get autocomplete suggestions | | getArtist(artistId) | Get artist details and songs | | getAlbum(albumId) | Get album tracks and info | | getPlaylist(playlistId) | Get playlist songs | | getLyrics(videoId) | Get song lyrics | | getTrendingSongs() | Get trending music |

Response Format

| Field | Type | Description | |-------|------|-------------| | videoId | string | YouTube video ID | | name | string | Song title | | artist | object | Artist information | | artist.artistId | string or null | Artist unique ID | | artist.name | string | Artist name | | album | object | Album information | | album.albumId | string | Album unique ID | | album.name | string | Album name | | duration | string or null | Song duration | | thumbnails | array | List of thumbnail images | | year | string or null | Release year |

Tech Stack

| Technology | Version | |------------|---------| | TypeScript | 5.1 | | Node.js | 16+ | | tsup | 8.1.0 | | axios | 1.7.2 | | zod | 3.23.8 |

Credits

| Role | Author | Package | |------|--------|---------| | Original Creator | Ateş Tan | youtube-music-api | | TypeScript Fork | zS1L3NT | ytmusic-api | | Node.js Port | Atex Ovi | atexovi-ytmusic-api |

License

GPL-3.0

Disclaimer: Unofficial API wrapper. May break if YouTube changes its structure.