Sign in
Authentication

Authenticate and start a session (deprecated)

When you do not have an API key you can request a session token using handshake which can then be used as your authentication token.

post/handshake

Query parameters

authstring

Passphrase (timestamp + password hash) or API key. Required unless using BearerAuth. Deprecated: for privacy, send this in a request body or the Authorization: Bearer header instead of the query string. Query-string support will be removed in API9.

userstring

Username (required for login/password authentication).

timestampinteger

UNIX time used in seed of password hash (required for login/password authentication).

versionstring

API version the client understands.

Response

Session info or error

authstring nullable
streamtokenstring nullable
apistring
updatestring
addstring
cleanstring
max_songinteger
max_albuminteger
max_artistinteger
max_videointeger
max_podcastinteger
max_podcast_episodeinteger
songsinteger
albumsinteger
artistsinteger
genresinteger
playlistsinteger
searchesinteger
playlists_searchesinteger
usersinteger
catalogsinteger
videosinteger
podcastsinteger
podcast_episodesinteger
sharesinteger
licensesinteger
live_streamsinteger
labelsinteger
usernamestring

Changes