Skip to content
spotuify

JSON Output

Machine-readable output is part of the product. Scripts and agents should prefer json, jsonl, or ids.

Pick a format

Section titled “Pick a format”
Terminal window
spotuify status --format json
spotuify search "luther" --format jsonl
spotuify playlists --format ids

Playback

Section titled “Playback”
Terminal window
spotuify status --format json

Expected shape:

{
  "device": {
    "id": "device-id",
    "name": "spotuify-hume"
  },
  "item": {
    "uri": "spotify:track:...",
    "name": "Track",
    "subtitle": "Artist"
  },
  "playing": true,
  "progress_ms": 42000
}

Search rows

Section titled “Search rows”
Terminal window
spotuify search "luther vandross" --type track --format jsonl

Expected row shape:

{
  "uri": "spotify:track:...",
  "id": "track-id",
  "kind": "track",
  "name": "Never Too Much",
  "subtitle": "Luther Vandross",
  "duration_ms": 216000,
  "source": "spotify"
}

Mutation receipts

Section titled “Mutation receipts”
Terminal window
spotuify next --format json

Expected shape:

{
  "ok": true,
  "action": "next",
  "message": "Skipped"
}

Playlist creation receipts include playlist data:

Terminal window
spotuify playlist create "Focus" --from candidates.jsonl --dry-run --format json
{
  "ok": true,
  "action": "playlist-create",
  "playlist_uri": "spotify:playlist:...",
  "name": "Focus",
  "added_item_count": 20
}

IDs

Section titled “IDs”
Terminal window
spotuify search "luther" --format ids

Expected shape:

spotify:track:...
spotify:album:...

See Also

Section titled “See Also”