POST /api/v1/radio/presets # Token writeor Session
Save a station as a preset.
Scope: write. One preset per station and band.
Request body required
application/json
object
station_id string required
A station list id, e.g. de0.d3c3.
band string required
fm or dab — which you listen to it on.
dial string | null
MHz for FM (95.8), the channel block for DAB (5C).
Responses
application/json
object
A station the listener saved, where it sits on their dial.
id integer · int64 required
station_id string required
<gcc>.<pi>, the directory's id.
dial string | null
MHz for FM (95.8), the channel block for DAB (5C).
position integer · int64 required
Order on the preset row, from 1.
400 Malformed or rejected input.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
401 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
object
Every error body in the API has this shape.
code integer · int32 required
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."
}
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
409 Already a preset on that band.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
POST /api/v1/radio/tuner # Token writeor Session
Tune in to a preset.
Scope: write. From now until you turn it off, tune elsewhere or the
auto-stop runs out, the server reads the station's stream for track names
and logs them under your rules. Replaces whatever you were tuned to.
Request body required
application/json
object
preset_id integer · int64 required
Responses
application/json
object
What GET /api/v1/radio/tuner returns.
preset object | null
A station the listener saved, where it sits on their dial.
id integer · int64 required
station_id string required
<gcc>.<pi>, the directory's id.
dial string | null
MHz for FM (95.8), the channel block for DAB (5C).
position integer · int64 required
Order on the preset row, from 1.
session_id integer | null · int64
since integer | null · int64
ends_at integer | null · int64
When auto-stop will end it, if it will.
state string | null
What the faceplate shows.
tuningliveunknownbreakdropped
now object | null
since integer · int64 required
tagged boolean required
MusicBrainz recognised it.
line string | null
The last thing the station said, verbatim.
source string | null
Where line came from: ICY today.
retry_at integer | null · int64
When a dropped stream is next retried.
signal integer · int32 required
0–5, the faceplate's bars: connection health, not RF signal.
chain_id integer | null · int64
401 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
object
Every error body in the API has this shape.
code integer · int32 required
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."
}
404 No such resource, or it belongs to another user.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
409 The station is not in the list, or publishes no stream.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
POST /api/v1/radio/log/{id}/keep # Token writeor Session
Keep a line from the review queue: write it as a listen.
Scope: write. It is forwarded like any other listen.
Responses
application/json
object
One thing a station said while you were tuned in.
id integer · int64 required
session_id integer · int64 required
station_id string required
station_name string required
started_at integer · int64 required
ended_at integer | null · int64
raw string required
Exactly what the station sent.
kind string required
track, guess, break or other.
status string required
playing, scrobbled, review, kept, dropped, held,
partial, skipped or logged.
source_id string | null
The listen this became, as scrobbles.source_id.
mbid_recording string | null
401 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
object
Every error body in the API has this shape.
code integer · int32 required
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."
}
404 No such resource, or it belongs to another user.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
409 Already settled, or already in your history.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
POST /api/v1/radio/log/{id}/drop # Token writeor Session
Drop a line from the review queue.
Scope: write. It stays in the air log, marked dropped, and never becomes
a listen.
Responses
application/json
object
One thing a station said while you were tuned in.
id integer · int64 required
session_id integer · int64 required
station_id string required
station_name string required
started_at integer · int64 required
ended_at integer | null · int64
raw string required
Exactly what the station sent.
kind string required
track, guess, break or other.
status string required
playing, scrobbled, review, kept, dropped, held,
partial, skipped or logged.
source_id string | null
The listen this became, as scrobbles.source_id.
mbid_recording string | null
401 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
object
Every error body in the API has this shape.
code integer · int32 required
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."
}
404 No such resource, or it belongs to another user.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.
application/json
object
Every error body in the API has this shape.
code integer · int32 required
error string required
Human-readable. Not a stable identifier — do not branch on it.