https://github.com/zo-bro-23/youtube-music-api

🖥️ API for @th-ch/youtube-music
https://github.com/zo-bro-23/youtube-music-api

api music remote youtube

Last synced: about 2 months ago
JSON representation

🖥️ API for @th-ch/youtube-music

• Host: GitHub
• URL: https://github.com/zo-bro-23/youtube-music-api
• Owner: Zo-Bro-23
• Created: 2023-02-21T11:03:39.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-31T02:30:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T17:24:04.489Z (3 months ago)
• Topics: api, music, remote, youtube
• Language: JavaScript
• Homepage: https://youtube-music-api.vercel.app
• Size: 34.5 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# youtube-music-api

🖥️ API for @th-ch/youtube-music

## Usage

- Install [@th-ch/youtube-music](https://github.com/th-ch/youtube-music)

- Enable the API plugin

- Click Plugins > API > Set API Key

- Make note of your current key or set a new one

- Use this key with all API calls to identify yourself

## Documentation

> **Note**

> The main API endpoint is `https://youtube-music-api.zohan.tech/api/`

### Current song

#### `GET /status`

**Query Params:**

- `key`: Your API key

### Song control

#### `POST /control`

**Request Body:**

- `key`: Your API key

- `controls`: A list (array) of controls to execute; controls can be:

    - `play`

    - `pause`

    - `playPause`

    - `previous`

    - `next`

    - `like`

    - `dislike`

    - `go10sBack`

    - `go10sForward`

    - `go1sBack`

    - `go1sBack`

    - `shuffle`

    - `switchRepeat`

    - `volumeMinus10`

    - `volumePlus10`

    - `fullscreen`

    - `muteUnmute`

    - `maximizeMinimisePlayer`

    - `goToHome`

    - `goToLibrary`

    - `goToSettings`

    - `goToExplore`

    - `search`

    - `showShortcuts`

## Android App

Download from [Google Play]() or use the latest APK from the `./android/` folder.

> **Warning**

> The API key set using the Android App is semi-permenant. To change the key go to Settings > Apps > Remote > Clear Data > Clear All Data.

### Screenshots