ytm / docs.md
veltrixcode's picture
Upload 8 files
7a11778 verified
|
Raw
History Blame Contribute Delete
1.23 kB

YouTube Music API (Unofficial)

Flask wrapper around ytmusicapi exposing simple unauthenticated endpoints.

Docs: /docs/ (Swagger UI) after running the server.

Quick start

  1. Create a virtualenv (optional)
  2. Install deps:
    pip install -r requirements.txt
    
  3. Run the server (dev):
    python app.py
    

For production, you can run with waitress:

waitress-serve --host=0.0.0.0 --port=8000 app:app

Endpoints (prefix: /api)

  • GET /health – health check
  • GET /search?q=...&filter=...&limit=...&official=...
  • GET /search/suggestions?q=...
  • GET /songs/{video_id}
  • GET /albums/{browse_id}
  • GET /artists/{browse_id}
  • GET /playlists/{playlist_id}?limit=...
  • GET /charts?country=..
  • GET /moods
  • GET /moods/{category_id}
  • GET /watch_playlist?videoId=...|playlistId=...&radio=true|false&shuffle=true|false&limit=...

Notes:

  • This is unauthenticated; some actions are limited compared to logged-in YT Music.
  • Refer to ytmusicapi docs for parameter semantics and response shapes.

References