Fork me on GitHub

“A personal music server
for everyone”

JSON API

As of version 1.4 Sockso provides a JSON API located under the /api root URL. This API exposes a read only JSON view of all the artists, albums, tracks and playlists stored in a Sockso server.

  • All endpoints return JSON, and are read-only.
  • Endpoints marked as "paged" return 100 items at a time by default, but this can be adjusted using "limit" and "offset" parameters.
  • A "limit" of -1 means no limit.
  • Offset can only be specified with a limit.
  • Requests should be GET.
  • $ID in endpoints indicates an integer ID

Endpoints

  • /api - Server info

Artists

  • /api/artists - Lists artists (paged)
  • /api/artists/$ID - Artist $ID
  • /api/artists/$ID/tracks - Tracks for artist $ID

Albums

  • /api/albums - Lists albums (paged)
  • /api/albums/$ID - Album $ID
  • /api/albums/$ID/tracks - Tracks for album $ID

Tracks

  • /api/tracks - Lists tracks (paged)
  • /api/tracks/$ID - Track $ID

Playlists

  • /api/playlists - Lists playlists (paged)
  • /api/playlists/$ID - Playlist $ID
  • /api/playlists/site - Lists site playlists (paged)
  • /api/playlists/user - Lists playlists for current user (paged)
  • /api/playlists/user/$ID - Lists playlists for specified user

Session

  • /api/session - Returns '1' or '0' indicating if current user has session.

Comments

  • No comments yet, be the first!

Post Comment

Just enter your name, fill out the easy captcha and enter your comments - it'll appear on the site right away. If you enter your email it will just be linked from your name so people can get in touch with you about your comment, so it's optional.

Sockso Community!

Sockso comes with the ability to be instantly part of the Sockso Community. So install now to to take part!

If you love using Sockso and would like to give a little back, try a donation to help out and support open source development.

Latest News & Releases RSS Icon

12th May

Sockso 1.5.3 - Bug fix release - fixes broken folder browsing and related artists.

29th April

Sockso 1.5.2 - Bug fix for broken local cover art, and updated French translation.

14th March 2012

Sockso 1.5.1 - Bug fixes for path security hole, API access, and encoded pluses. Along with updated Italian translation, adding ability to extract cover art from ID3 tags.

10th December

Sockso 1.5 - Added ability to add arbitrary meta tags, JPlayer support, HTTP Range header support, bug fixes, and finalised API v1.0

25th July

Sockso 1.4.2 - Fix for fetching cover artwork from Amazon.

24th July

Sockso 1.4.1 - Fixes for unicode output issue, and strict JSON API issue with single quotes.

23rd July

Sockso 1.4 - Added a JSON API to support developing applications on top of Sockso.

8th July

Posted screencast of *VERY* early version of new Sockso iPhone app. Feedback appreciated in the forums.

2nd July

Sockso 1.3.5 - Fix for problem on OSX where Sockso would not start, other minor bug fixes for Flac handling.

26th June

Sockso 1.3.4 - New HTML5 Player for iPad/iOS/etc support from nguillaumin, new 'tinygreen' skin from Simplify, and some bug fixes.

4th May

Sockso 1.3.3 - Album years now shown, Turkish translation added, and MP3 tag library updated (all thanks to badZeppelin!), some bug fixes to ajax page loading.

2nd April

Sockso 1.3.2 - Users can now require approval when registering, and updated ajaxified web interface with embedded player now default.

23rd March

Sockso 1.3.1 - Fix for missing 'colscan' command from console, moved optional libraries location (to upgrade rename your optionals folder from 'lib-opt' to 'lib/opt', and a bug fix for invalid URL characters breaking some playlist files.

17th March

Sockso 1.3 - Created ability to add servers to the new Sockso Community, and you can now run behind Apache without needing a VirtualHost (thanks to LightGlitch!)

5th February

Sockso 1.2.7 - Fix for broken javascript in 1.2.6.

30th January 2011

Sockso 1.2.6 (broken) - Fix for selecting the playlist in some browsers, and added new web admin console.

17th December

Sockso 1.2.5 - Minor bug fix for adding items to the playlist when browsing folders.

10th April

Sockso 1.2.4 - Patches from Will to improve HTTP/HTTPS streaming performance, and HTML compliance, improved music tree in GUI to cope with any size collections, hidden files now ignored on indexing, and some other bugs.

8th February

Sockso 1.2.3 - Fixed broken 1.2.2 release.

Linux Logo Windows Logo OSX Logo