2020-01-21 04:55:59 +01:00
|
|
|
|
|
|
|
|
### Supported Subsonic API endpoints
|
|
|
|
|
|
2020-01-24 17:35:15 +01:00
|
|
|
Navidrome is currently compatible with [Subsonic API](http://www.subsonic.org/pages/api.jsp) v1.8.0, with some exceptions.
|
2020-01-21 04:55:59 +01:00
|
|
|
|
2020-01-24 01:44:08 +01:00
|
|
|
This is an (almost) up to date list of all Subsonic API endpoints implemented by Navidrome.
|
2020-01-21 04:55:59 +01:00
|
|
|
Check the "Notes" column for limitations/missing behaviour. Also keep in mind these differences between
|
2020-01-24 01:44:08 +01:00
|
|
|
Navidrome and Subsonic:
|
2020-01-21 04:55:59 +01:00
|
|
|
|
2020-01-24 01:44:08 +01:00
|
|
|
* Right now, Navidrome only works with a single Music Library (Music Folder)
|
|
|
|
|
* Navidrome does not mark songs as played by calls to `stream`, only when
|
2020-01-21 04:55:59 +01:00
|
|
|
`scrobble` is called with `submission=true`
|
|
|
|
|
* Next features to be implemented: Playlists (WIP), MultiUser (WIP), Jukebox, Sharing, Podcasts, Bookmarks, Internet Radio.
|
|
|
|
|
|
2020-01-24 04:57:51 +01:00
|
|
|
Navidrome is actively being tested with:
|
|
|
|
|
[DSub](http://www.subsonic.org/pages/apps.jsp#dsub),
|
|
|
|
|
[Music Stash](https://play.google.com/store/apps/details?id=com.ghenry22.mymusicstash) and
|
|
|
|
|
[Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash))
|
|
|
|
|
|
2020-01-21 04:55:59 +01:00
|
|
|
|
|
|
|
|
| ENDPOINT | NOTES |
|
|
|
|
|
|------------------------|-------|
|
|
|
|
|
| _SYSTEM_ ||
|
|
|
|
|
| `ping` | |
|
|
|
|
|
| `getLicense` | Always valid ;) |
|
|
|
|
|
| ||
|
|
|
|
|
| _BROWSING_ ||
|
2020-02-02 00:46:16 +01:00
|
|
|
| `getMusicFolders` | Hardcoded to just one, set with ND_MUSICFOLDER configuration |
|
2020-01-21 04:55:59 +01:00
|
|
|
| `getIndexes` | Doesn't support shortcuts, nor direct children |
|
|
|
|
|
| `getMusicDirectory` | |
|
|
|
|
|
| `getSong` | |
|
|
|
|
|
| `getArtists` | |
|
|
|
|
|
| `getArtist` | |
|
|
|
|
|
| `getAlbum` | |
|
|
|
|
|
| `getGenres` | |
|
|
|
|
|
| ||
|
|
|
|
|
| _ALBUM/SONGS LISTS_ ||
|
|
|
|
|
| `getAlbumList` | `byYear` and `byGenre` are not implemented |
|
|
|
|
|
| `getAlbumList2` | `byYear` and `byGenre` are not implemented |
|
2020-01-21 14:49:43 +01:00
|
|
|
| `getStarred` | |
|
|
|
|
|
| `getStarred2` | |
|
2020-01-21 04:55:59 +01:00
|
|
|
| `getNowPlaying` | |
|
2020-02-02 00:46:16 +01:00
|
|
|
| `getRandomSongs` | Ignores `fromYear` and `toYear` parameters |
|
2020-01-21 04:55:59 +01:00
|
|
|
| ||
|
|
|
|
|
| _SEARCHING_ ||
|
|
|
|
|
| `search2` | Doesn't support Lucene queries, only simple auto complete queries |
|
|
|
|
|
| `search3` | Doesn't support Lucene queries, only simple auto complete queries |
|
|
|
|
|
| ||
|
2020-01-21 23:31:07 +01:00
|
|
|
| _PLAYLISTS_ ||
|
|
|
|
|
| `getPlaylists` | `username` parameter is not implemented |
|
|
|
|
|
| `getPlaylist` | |
|
|
|
|
|
| `createPlaylist` | Return empty response on success |
|
2020-01-22 00:15:16 +01:00
|
|
|
| `updatePlaylist` | `comment` and `public` are not implemented. All playlists are public |
|
2020-01-21 23:31:07 +01:00
|
|
|
| `deletePlaylist` | |
|
|
|
|
|
| ||
|
2020-01-21 04:55:59 +01:00
|
|
|
| _MEDIA RETRIEVAL_ ||
|
2020-02-03 17:50:46 +01:00
|
|
|
| `stream` | No Transcoding/Downsampling support (for now)|
|
2020-01-21 04:55:59 +01:00
|
|
|
| `download` | |
|
|
|
|
|
| `getCoverArt` | Only gets embedded artwork |
|
|
|
|
|
| `getAvatar` | Always returns the same image |
|
|
|
|
|
| ||
|
|
|
|
|
| _MEDIA ANNOTATION_ ||
|
|
|
|
|
| `star` | |
|
|
|
|
|
| `unstar` | |
|
|
|
|
|
| `setRating` | Doesn't work with artists |
|
2020-01-27 10:32:55 +01:00
|
|
|
| `scrobble` | No Last.FM support yet. It is used to update play count and last played |
|
2020-01-21 04:55:59 +01:00
|
|
|
| ||
|
|
|
|
|
| _USER MANAGEMENT_ ||
|
|
|
|
|
| `getUser` | Hardcoded all roles, ignores `username` parameter|
|
