User preferences.
Session-only.
Responses
OK.
application/json
Free-form. The keys below are the ones the server reads; any other key is the web UI's own and is stored verbatim.
Takes further properties besides these, and keeps them as sent.
timezone string An IANA region, e.g. Europe/Berlin — never a fixed abbreviation like CET. Decides "today", the heatmap and every calendar bucket. UTC when unset.
credit_primary string Who a classical listen is filed under when MusicBrainz names both the performers and the work's composer: performer (the default) or composer. Only reorders who is credited; changing it re-files the MusicBrainz-credited listens in the background.
split_classical boolean Keep classical out of Top Charts and rank it in the Classical tab instead. true when unset. Statistics, Dashboard and Reports always count everything.
split_scores boolean Keep film, game and TV score, and ambient, out of Top Charts and in the Scores & Ambient tab. true when unset. Songs from soundtracks always stay in Top Charts.
week_start integer First day of the week, 0 = Sunday … 6 = Saturday. Monday (1) when unset.
scrobble_threshold_percent number When a listen counts: this share of the track, 5–100. Read the clamped value from GET /api/v1/scrobble-settings.
scrobble_threshold_secs integer …or this many seconds, whichever comes first, 10–3600.
rating_scale string The scale rating_love_threshold is written on. Set by POST /api/v1/ratings/apply.
rating_love_threshold number The media-server rating at or above which a track counts as loved, on rating_scale.
rating_love_starred boolean Whether a starred (favourited) item counts as loved whatever its rating. True when unset.
lyrics_indic_style string How Indian scripts are romanized in the lyrics reader: readable (lyric-site spelling, the default) or iso (ISO 15919).
lyrics_cyrillic_style string How Russian is romanized in the lyrics reader: readable (Wikipedia's spelling, the default) or iso (ISO 9).
lyrics_macrons boolean Romanized Japanese with macrons (Tōkyō) rather than spelled out (toukyou). False when unset.
lyrics_view string original, romanized or both — what the reader, deck strip and notes show for a lyric that is romanized. The web UI's.
theme string light, dark or system. The web UI's.
No valid session cookie or token. Also returned when a token is presented to a session-only endpoint — the endpoint does not accept tokens at all, so the scope is irrelevant.
application/json
Every error body in the API has this shape.
code integer · int32 required Mirrors the HTTP status.
error string required Human-readable. Not a stable identifier — do not branch on it.
{
"code": 401,
"error": "Authentication required. Log in to access this endpoint."
}