Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Dear API, you deserve a better documentation. KR.

  • Loading branch information...
commit 0b502018ddb0b4e4fcd4ef5441f2cd86399d63e4 1 parent e151a89
@tchapi tchapi authored
Showing with 2,884 additions and 470 deletions.
  1. +61 −470 README.md
  2. 0  { → consoles}/qobuz-apigee-wadl.xml
  3. +245 −0 endpoints/album/get.md
  4. +72 −0 endpoints/album/getFeatured.md
  5. +74 −0 endpoints/album/search.md
  6. +47 −0 endpoints/article/get.md
  7. +63 −0 endpoints/article/listLastRubrics.md
  8. +66 −0 endpoints/article/listRubrics.md
  9. +48 −0 endpoints/artist/get.md
  10. +59 −0 endpoints/artist/getSimilarArtists.md
  11. +54 −0 endpoints/artist/search.md
  12. +40 −0 endpoints/favorite/create.md
  13. +40 −0 endpoints/favorite/delete.md
  14. +75 −0 endpoints/favorite/getUserFavorites.md
  15. +39 −0 endpoints/genre/get.md
  16. +87 −0 endpoints/genre/list.md
  17. +40 −0 endpoints/label/get.md
  18. +70 −0 endpoints/label/list.md
  19. +39 −0 endpoints/playlist/addTracks.md
  20. +52 −0 endpoints/playlist/create.md
  21. +36 −0 endpoints/playlist/delete.md
  22. +39 −0 endpoints/playlist/deleteTracks.md
  23. +149 −0 endpoints/playlist/get.md
  24. +68 −0 endpoints/playlist/getPublicPlaylists.md
  25. +75 −0 endpoints/playlist/getUserPlaylists.md
  26. +36 −0 endpoints/playlist/subscribe.md
  27. +36 −0 endpoints/playlist/unsubscribe.md
  28. +54 −0 endpoints/playlist/update.md
  29. +36 −0 endpoints/playlist/updatePlaylistsPosition.md
  30. +42 −0 endpoints/playlist/updateTracksPosition.md
  31. +72 −0 endpoints/purchase/getArticles.md
  32. +180 −0 endpoints/purchase/getUserPurchases.md
  33. +132 −0 endpoints/search/getBestMatch.md
  34. +47 −0 endpoints/search/getResultCount.md
  35. +173 −0 endpoints/search/getResults.md
  36. +34 −0 endpoints/template.md
  37. +75 −0 endpoints/track/get.md
  38. +41 −0 endpoints/track/getFileUrl.md
  39. +130 −0 endpoints/track/search.md
  40. +158 −0 endpoints/user/login.md
View
531 README.md
@@ -102,509 +102,100 @@ API responses throwing errors will have an HTTP error code and a body with a hum
+ `404` - Not Found - The requested item doesn't exist.
+ `50x` - Server errors - something went wrong on Qobuz's end.
-## Methods
-
-+ **user**
- + [login](#user/login)
-+ **playlist**
- + [getUserPlaylists](#playlist/getUserPlaylists)
- + [get](#playlist/get)
- + [create](#playlist/create)
- + [update](#playlist/update)
- + [delete](#playlist/delete)
- + [updatePlaylistsPosition](#playlist/updatePlaylistsPosition)
- + [addTracks](#playlist/addTracks)
- + [updateTracksPosition](#playlist/updateTracksPosition)
- + [deleteTracks](#playlist/deleteTracks)
- + [subscribe](#playlist/subscribe)
- + [unsubscribe](#playlist/unsubscribe)
- + [getPublicPlaylists](#playlist/getPublicPlaylists)
-+ **search**
- + [getResults](#search/getResults)
- + [getResultCount](#search/getResultCount)
- + [getBestMatch](#search/getBestMatch)
-+ **album**
- + [get](#album/get)
- + [getFeatured](#album/getFeatured)
- + [search](#album/search)
-+ **track**
- + [get](#track/get)
- + [getFileUrl](#track/getFileUrl)
- + [search](#track/search)
-+ **artist**
- + [get](#artist/get)
- + [getSimilarArtists](#artist/getSimilarArtists)
- + [search](#artist/search)
-+ **purchase**
- + [getUserPurchases](#purchase/getUserPurchases)
- + [getArticles](#purchase/getArticles)
-+ **favorite**
- + [getUserFavorites](#favorite/getUserFavorites)
- + [create](#favorite/create)
- + [delete](#favorite/delete)
-+ **genre**
- + [list](#genre/list)
- + [get](#genre/get)
-+ **label**
- + [list](#label/list)
- + [get](#label/get)
-+ **article**
- + [lastArticles](#article/listLastArticles)
- + [get](#article/get)
-+ **status**
- + [test](#status/test)
-
-
-### user/login <a name="user/login"></a>
-
-> Return a session token for a user. Read the Authentication section for more information.
-> Note: If available, the User Auth Token can be used as the only argument.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `username` - _required_ : The username of the user.
-> + `email` - _optional_ : Alternatively, its email address.
-> + `password` - _required_ : MD5 hash of the user password.
-> + `user_auth_token` - _optional_ : Or the authenticated user token (see [User authentication](#user-auth))
->
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/user/login?app_id=100000000&username=foo&password=3858f62230ac3c915f300c664312c63f
-
-
-### playlist/getUserPlaylists <a name="playlist/getUserPlaylists"></a>
-
-> Get both public and private playlists of the authenticated user. Return only public playlists of the user if the request is not authenticated.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_id` - _optional_ : The user ID to fetch the playlists of.
-> + `username` - _optional_ : Alternatively, its username.
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/playlist/getUserPlaylists?app_id=100000000&username=loris
-
-### playlist/get <a name="playlist/get"></a>
-
-> Get the metadata for a playlist, including tracks and subscribers.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `playlist_id` - _required_ : The playlist ID to fetch the metadata of.
-> + `extra` - _optional_ : Extra fields to include in the response (comma-separated) : `tracks`, ...
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/playlist/get?app_id=100000000&playlist_id=49806&extra=tracks
-
-### playlist/create <a name="playlist/create"></a>
-
-> Create a playlist on behalf of the authenticated user. Return the created playlist in case of success.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `name` - _required_ : Name for the playlist.
-> + `description` - _optional_ : Description for the playlist.
-> + `is_public` - _optional_ : Flag to make the playlist public.
-> + `is_collaborative` - _optional_ : Flag to make the playlist collaborative.
-> + `track_ids` - _optional_ : Initial tracks to add to the playlist.
-> + `album_id` - _optional_ : Initial album to add to the playlist.
-
-### playlist/update <a name="playlist/update"></a>
-
-> Update a playlist. Require playlist owner authentication except if the playlist is public and collaborative.
-> If you provide track_ids with this method, the actual tracks of the playlist will be removed before adding the new ones.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_id` - _required_ : The playlist ID to update.
-> + `name` - _optional_ : Name for the playlist.
-> + `description` - _optional_ : Description for the playlist.
-> + `is_public` - _optional_ : Flag to make the playlist public.
-> + `is_collaborative` - _optional_ : Flag to make the playlist collaborative.
-> + `track_ids` - _optional_ : Tracks to replace the initial tracks with.
-
-### playlist/delete <a name="playlist/delete"></a>
-
-> Delete a playlist. Require playlist owner authentication.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_id` - _required_ : The playlist ID to delete.
-
-### playlist/updatePlaylistsPosition <a name="playlist/updatePlaylistsPosition"></a>
-
-> Updates the user playlists display order. Requires user authentication.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_ids` - _required_ : Comma-separated, ordered list of playlist IDs.
-
-### playlist/addTracks <a name="playlist/addTracks"></a>
-
-> Add tracks in the playlist queue. Require playlist owner authentication except if the playlist is public and collaborative.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_id` - _required_ : The playlist ID to add the tracks to.
-> + `track_ids` - _optional_ : Comma-separated, ordered list of track IDs.
-
-### playlist/updateTracksPosition <a name="playlist/updateTracksPosition"></a>
-
-> Update the tracks position in the playlist. Require playlist owner authentication except if the playlist is public and collaborative.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_id` - _required_ : The playlist ID to update the tracks position of.
-> + `playlist_track_ids` - _optional_ : Comma-separated, ordered list of playlist track IDs.
-> + `insert_before` - _required_ : The playlist position where to start replacing the tracks position.
-
-### playlist/deleteTracks <a name="playlist/deleteTracks"></a>
-
-> Delete tracks from the playlist. Require playlist owner authentication except if the playlist is public and collaborative.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_id` - _required_ : The playlist ID to delete the tracks from.
-> + `playlist_track_ids` - _optional_ : Comma-separated list of playlist track IDs to delete.
-
-### playlist/subscribe <a name="playlist/subscribe"></a>
-
-> Subscribe the authenticated user to the playlist.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `playlist_id` - _required_ : The playlist ID to subscribe the user to.
-
-### playlist/unsubscribe <a name="playlist/unsubscribe"></a>
-
-> Unsubscribe the authenticated user from the playlist.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-+ `playlist_id` - _required_ : The playlist ID to unsubscribe the user from.
-
-### playlist/getPublicPlaylists <a name="playlist/getPublicPlaylists"></a>
-
-> Return a list of public user playlists.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `type` - _optional_ : The query type, ie. `last-created`, ...
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/playlist/getPublicPlaylists?app_id=100000000&type=last-created
-
-### search/getResults <a name="search/getResults"></a>
-
-> Search for objects, may it be tracks, albums or artists, by name. Return the matches sorted by relevance.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `query` - _required_ : The term to search for.
-> + `type` - _optional_ : Specifies a type (either 'tracks', 'albums', or 'artists') to narrow down the search. In this case, only the number of results for other objects will be returned.
->
-> #### Suggestions
-
-> In case the search engine detects a typo in the query term(s), a 'suggestions' node will be added to the response
-
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/search/getResults?app_id=100000000&query=Watch%20The%20Throne&type=tracks
-
-### search/getResultCount <a name="search/getResultCount"></a>
-
-> Search for objects, may it be tracks, albums or artists, by name. Return the number of matches only.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `query` - _required_ : The term to search for.
->
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/search/getResultCount?app_id=100000000&query=Watch%20The%20Throne
-
-### search/getBestMatch <a name="search/getBestMatch"></a>
-
-> Search for an equivalent object, by title, artist, album or ISRC. Returns only one object.
->
-> If the ISRC is present and valid, it will be taken as the strongest bind and thus used to find the equivalent recording in the database. In case ISRC is not used or is invalid, the title, album and artist terms will be used to find the closest match in our database.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `type` - _required_ : The type of object to search the equivalent for
-> + `isrc` - _optional_ : specifies an ISRC (XX-YYY-NN-ZZZZZ) (for type = 'tracks' only)
-> + `title` - _optional_ : Specifies a title to search for (for type = 'tracks' only)
-> + `album` - _optional_ : Specifies an album title to search for (for type = 'tracks' and 'album' only)
-> + `artist` - _optional_ : Specifies an artist name to search for (for all types)
-> + `availableForStreaming` - _optional_ : Specifies whether the returned object must be streamable or not (for type = 'tracks' only)
-
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/search/getBestMatch?app_id=100000000&isrc=Frt155607031&type=tracks&title=Don%20Giovanni
-> http://www.qobuz.com/api.json/0.2/search/getBestMatch?app_id=100000000&artist=radiohead&album=pablo&type=albums
-
-
+***
-### album/get <a name="album/get"></a>
-
-> Return the metadata for a album (or music album)
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `album_id` - _required_ : The album ID to fetch the metadata of.
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/album/get?app_id=100000000&album_id=0060252780907
-
-### album/search <a name="album/search"></a>
-
-> Search for albums by name. Return album matches sorted by relevance.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `query` - _required_ : The term to search for.
->
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/album/search?app_id=100000000&query=Watch%20The%20Throne
-
-### album/getFeatured <a name="album/getFeatured"></a>
-
-> Return album recommandations by type and/or genre.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `type` - _optional_ : The type of recommandations to fetch: `best-sellers`, `new-releases`, `press-awards`, `editor-picks`, `most-featured
-> + `genre_id` - _optional_ : The genre ID to filter the recommandations by.
->
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/album/getFeatured?app_id=100000000&type=new-releases&genre_id=64
-
-### track/get <a name="track/get"></a>
-
-> Return the metadata for a track
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `track_id` - _required_ : The track ID to fetch the metadata of.
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/track/get?app_id=1000000000&track_id=3453569
-
-### track/getFileUrl <a name="track/getFileUrl"></a>
-
-> Return the file url of the track. Require request signature and user authentication to access full-length track.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `request_ts` - _required_ : The request timestamp (see [Signed requests authentification](#request-signature))
-> + `request_sig` - _required_ : The request signature (see [Signed requests authentification](#request-signature))
-> + `track_id` - _required_ : The track ID to get the file url of.
-> + `format_id` - _optional_ : The format ID of the file (`5` for MP3 320, `6` for FLAC Lossless)
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
->
-
-
-### track/search <a name="track/search"></a>
-
-> Search for a track by name. Return track matches sorted by relevance.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `query` - _required_ : The term to search for.
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/track/search?app_id=100000000&query=Thriller
-
-### artist/get <a name="artist/get"></a>
-
-> Return the metadata for an artist
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `artist_id` - _required_ : The artist ID to fetch the metadata of.
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/artist/get?app_id=100000000&artist_id=118680
-
-### artist/getSimilarArtists <a name="artist/getSimilarArtists"></a>
+## Methods
-> Return similar artists for an artist
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `artist_id` - _required_ : The artist ID to fetch the metadata of.
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/artist/getSimilarArtists?app_id=100000000&artist_id=118680
+### status
-### artist/search <a name="artist/search"></a>
+> Get the status of the API
-> Search for an artist by name. Return artist matches sorted by relevance.
->
> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `query` - _required_ : The term to search for.
->
-> #### Example
-> http://www.qobuz.com/api.json/0.2/artist/search?app_id=100000000&query=MGMT
-### purchase/getUserPurchases <a name="purchase/getUserPurchases"></a>
+ + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> Return the articles (albums and tracks) purchased by the authenticated user on Qobuz music store.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `order_id` - _optional_ : If indicated, only returns the articles associated with the order
-> + `flat`- _optional_ : when flat=1, returns all articles as tracks
->
> #### Example
-> http://www.qobuz.com/api.json/0.2/purchase/getUserPurchases?app_id=100000000&user_auth_token=45fopkfç_eç!09Içfmopkfezefopk
-
-### purchase/getArticles <a name="purchase/getArticles"></a>
-> Return the articles available for purchase, including prices and qualities.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `album_id` - _required_ : The album ID to fetch the articles from.
-> + `track_id` - _optional_ : Or, the track ID to fetch the articles from.
->
-> #### Example
-
-> http://www.qobuz.com/api.json/0.2/purchase/getArticles?app_id=100000000&album_id=0060252780907
-
-### favorite/getUserFavorites <a name="favorite/getUserFavorites"></a>
-
-> Return the authenticated user or specified user_id favorites filtered by item type.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](#user-auth))
-> + `user_id` - _optional_ : The User ID to fetch the favorites from
-> + `type` - _optional_ : The favorites type (`tracks`, `albums`, `artists`).
-
-### favorite/create <a name="favorite/create"></a>
-
-> Create favorites. Require user authentication.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `artist_ids` - _required_ : List of artist_ids to add to favorites
-> + `album_ids` - _required_ : List of album_ids to add to favorites
-> + `track_ids` - _required_ : List of track_ids to add to favorites
+ http://www.qobuz.com/api.json/0.2/status/test?app_id=100000000
-### favorite/delete <a name="favorite/delete"></a>
+> #### Returns
-> Delete favorites. Require user authentication.
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](#user-auth))
-> + `artist_ids` - _required_ : List of artist_ids to remove from favorites
-> + `album_ids` - _required_ : List of album_ids to remove from favorites
-> + `track_ids` - _required_ : List of track_ids to remove from favorites
+```json
+{
+ "status": "success"
+}
+```
-### genre/list <a name="genre/list"></a>
+### user
-> Lists all the sub-genres of a parent genre of music. If parent_id is omitted, all the root level genres are retured
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `parent_id` - _optional_ : The ID of a genre
->
-> #### Example
++ **[login](https://github.com/Qobuz/api-documentation/blob/master/endpoints/user/login.md)**
-> http://www.qobuz.com/api.json/0.2/genre/list?app_id=100000000&parent_id=64
+### playlist
-### genre/get <a name="genre/get"></a>
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/get.md)**
++ **[create](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/create.md)**
++ **[update](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/update.md)**
++ **[delete](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/delete.md)**
++ **[addTracks](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/addTracks.md)**
++ **[deleteTracks](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/deleteTracks.md)**
++ **[updateTracksPosition](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/updateTracksPosition.md)**
++ **[updatePlaylistsPosition](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/updatePlaylistsPosition.md)**
++ **[subscribe](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/subscribe.md)**
++ **[unsubscribe](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/unsubscribe.md)**
++ **[getUserPlaylists](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/getUserPlaylists.md)**
++ **[getPublicPlaylists](https://github.com/Qobuz/api-documentation/blob/master/endpoints/playlist/getPublicPlaylists.md)**
-> Get details for a genre of music
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `genre_id` - _required_ : The ID of a genre
-> + `extra` - _optional_ : provides extra details for the genre, such as albumsCount (the number of albums in the genre), subgenresCount (the number of direct children genres of this genre), allSubgenresCount (the total number of subgenres of this genre), albums (all the albums associated to the genre), artists, artistsCount, tracks, tracksCount
->
-> #### Example
+### search
-> http://www.qobuz.com/api.json/0.2/genre/list?app_id=100000000&genre_id=64&extra=subgenresCount
++ **[getResults](https://github.com/Qobuz/api-documentation/blob/master/endpoints/search/getResults.md)**
++ **[getResultCount](https://github.com/Qobuz/api-documentation/blob/master/endpoints/search/getResultCount.md)**
++ **[getBestMatch](https://github.com/Qobuz/api-documentation/blob/master/endpoints/search/getBestMatch.md)**
+### album
-### label/list <a name="label/list"></a>
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/album/get.md)**
++ **[getFeatured](https://github.com/Qobuz/api-documentation/blob/master/endpoints/album/getFeatured.md)**
++ **[search](https://github.com/Qobuz/api-documentation/blob/master/endpoints/album/search.md)**
-> Lists all the labels available on Qobuz
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
->
-> #### Example
+### track
-> http://www.qobuz.com/api.json/0.2/label/list?app_id=100000000
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/track/get.md)**
++ **[getFileUrl](https://github.com/Qobuz/api-documentation/blob/master/endpoints/track/getFileUrl.md)**
++ **[search](https://github.com/Qobuz/api-documentation/blob/master/endpoints/track/search.md)**
-### label/get <a name="label/get"></a>
+### artist
-> Get details for a music label
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `label_id` - _required_ : The ID of a genre
-> + `extra` - _optional_ : provides extra details for the label, such as albumsCount (the number of albums in the label), albums (all the albums associated to the label), artists, artistsCount, tracks, tracksCount
->
-> #### Example
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/artist/get.md)**
++ **[getSimilarArtists](https://github.com/Qobuz/api-documentation/blob/master/endpoints/artist/getSimilarArtists.md)**
++ **[search](https://github.com/Qobuz/api-documentation/blob/master/endpoints/artist/search.md)**
-> http://www.qobuz.com/api.json/0.2/label/list?app_id=100000000&label_id=1233
+### purchase
-### article/listLastArticles <a name="article/listLastArticles"></a>
++ **[getUserPurchases](https://github.com/Qobuz/api-documentation/blob/master/endpoints/purchase/getUserPurchases.md)**
++ **[getArticles](https://github.com/Qobuz/api-documentation/blob/master/endpoints/purchase/getArticles.md)**
-> Lists the last articles in the specified rubrics; If no rubric is specified, last articles from all rubrics are returned
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `rubric_ids` - _optional_ : The ID of rubrics
->
-> #### Example
+### favorite
-> http://www.qobuz.com/api.json/0.2/article/listLastArticles?app_id=100000000&parent_id=64
++ **[getUserFavorites](https://github.com/Qobuz/api-documentation/blob/master/endpoints/favorite/getUserFavorites.md)**
++ **[create](https://github.com/Qobuz/api-documentation/blob/master/endpoints/favorite/create.md)**
++ **[delete](https://github.com/Qobuz/api-documentation/blob/master/endpoints/favorite/delete.md)**
-### article/listRubrics <a name="article/listRubrics"></a>
+### genre
-> Get the list of available rubrics
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `extra` - _optional_ : provides extra details for the rubric, such as articlesCount (the number of articles in the rubric)
->
-> #### Example
++ **[list](https://github.com/Qobuz/api-documentation/blob/master/endpoints/genre/list.md)**
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/genre/get.md)**
-> http://www.qobuz.com/api.json/0.2/article/listRubrics?app_id=100000000&extra=articlesCount
+### label
-### article/get <a name="article/get"></a>
++ **[list](https://github.com/Qobuz/api-documentation/blob/master/endpoints/label/list.md)**
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/label/get.md)**
-> Get details for an article
->
-> #### Arguments
-> + `app_id` - _required_ : Your Application ID (see [Application authentication](#application-auth))
-> + `article_id` - _required_ : The ID of an article
->
-> #### Example
+### article
-> http://www.qobuz.com/api.json/0.2/article/get?app_id=100000000&article_id=2263
++ **[lastArticles](https://github.com/Qobuz/api-documentation/blob/master/endpoints/article/listLastArticles.md)**
++ **[get](https://github.com/Qobuz/api-documentation/blob/master/endpoints/article/get.md)**
+***
## Clients
@@ -628,5 +219,5 @@ API responses throwing errors will have an HTTP error code and a body with a hum
## Contact
+ **Email:** api@qobuz.com
-+ **Twitter:** @qobuz
++ **Twitter:** [@qobuz](https://twitter.com/qobuz)
+ **IRC:** #qobuz on irc.freenode.org
View
0  qobuz-apigee-wadl.xml → consoles/qobuz-apigee-wadl.xml
File renamed without changes
View
245 endpoints/album/get.md
@@ -0,0 +1,245 @@
+# Album Service : get
+
+ GET album/get
+
+## Description
+
+Return the metadata for an album.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `album_id` - _required_ : The album ID to fetch the metadata of.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/album/get?app_id=100000000&album_id=0060252780907
+
+**Return**
+
+```json
+{
+ "id": "0060252780907",
+ "title": "Watch The Throne",
+ "released_at": 1347228000,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0060/0060252780907_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0060/0060252780907_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0060/0060252780907_50.jpg",
+ "back": null
+ },
+ "artist": {
+ "id": 62054,
+ "name": "Jay-Z"
+ },
+ "label": {
+ "id": 17119,
+ "name": "Universal Music Division Barclay"
+ },
+ "genre": {
+ "id": 127,
+ "name": "Soul Funk Rap"
+ },
+ "description": "Lorsque les deux poids lourds du rap contemporain se retrouvent sur un même ring, le match ne peut qu’être surpuissant. Et ce <i>Watch The Throne</i> l’est ! Une fois oubliés le strass et les paillettes de cette double tête d’affiche, reste un bel exercice de soul urbaine et de hip hop futuriste. La rime est riche, la production éclectique dans ses textures sonores et aucun des deux ne cherche à tirer à lui la couverture. Un vrai festin pour les fans de hip hop.",
+ "url": "http://www.qobuz.com/album/watch-the-throne-jay-z-kanye-west/0060252780907",
+ "awards": [
+ {
+ "slug": "pitchfork",
+ "award_slug": "pitchfork",
+ "name": "Pitchfork: Best New Music",
+ "awarded_at": 1312149600,
+ "updated_at": "2012-02-17 10:49:50"
+ },
+ {
+ "slug": "les-inrocks",
+ "award_slug": "selection_inrocks",
+ "name": "Sélection Les Inrocks",
+ "awarded_at": 1312149600,
+ "updated_at": "2012-02-17 10:49:50"
+ }
+ ],
+ "goodies": [
+ {
+ "file_format_id": 21,
+ "name": "Livret numérique",
+ "description": "Jay-Z & Kanye West - Watch The Throne",
+ "url": "http://www.qobuz.com/goodies/000014413.swf"
+ }
+ ],
+ "tracks": {
+ "offset": 0,
+ "limit": null,
+ "total": 12,
+ "items": [
+ {
+ "id": 3809940,
+ "title": "No Church In The Wild (Album Version (Explicit))",
+ "track_number": 1,
+ "media_number": 1,
+ "duration": 272,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809941,
+ "title": "Lift Off (Album Version (Explicit))",
+ "track_number": 2,
+ "media_number": 1,
+ "duration": 266,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809942,
+ "title": "Ni**as In Paris (Album Version (Explicit))",
+ "track_number": 3,
+ "media_number": 1,
+ "duration": 219,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809943,
+ "title": "Otis (Album Version (Explicit))",
+ "track_number": 4,
+ "media_number": 1,
+ "duration": 178,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809944,
+ "title": "Gotta Have It (Album Version (Explicit))",
+ "track_number": 5,
+ "media_number": 1,
+ "duration": 140,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809945,
+ "title": "New Day (Album Version (Explicit))",
+ "track_number": 6,
+ "media_number": 1,
+ "duration": 272,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809946,
+ "title": "That's My Bitch (Album Version (Explicit))",
+ "track_number": 7,
+ "media_number": 1,
+ "duration": 202,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809947,
+ "title": "Welcome To The Jungle (Album Version (Explicit))",
+ "track_number": 8,
+ "media_number": 1,
+ "duration": 174,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809948,
+ "title": "Who Gon Stop Me (Album Version (Explicit))",
+ "track_number": 9,
+ "media_number": 1,
+ "duration": 256,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809949,
+ "title": "Murder To Excellence (Album Version (Explicit))",
+ "track_number": 10,
+ "media_number": 1,
+ "duration": 300,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809950,
+ "title": "Made In America (Album Version (Explicit))",
+ "track_number": 11,
+ "media_number": 1,
+ "duration": 292,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ },
+ {
+ "id": 3809951,
+ "title": "Why I Love You (Album Version (Explicit))",
+ "track_number": 12,
+ "media_number": 1,
+ "duration": 201,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 62054,
+ "name": "Jay-Z"
+ }
+ }
+ ]
+ }
+}
+```
View
72 endpoints/album/getFeatured.md
@@ -0,0 +1,72 @@
+# Album Service : getFeatured
+
+ GET album/getFeatured
+
+## Description
+
+Return album recommandations by type and/or genre.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `type` - _optional_ : The type of recommandations to fetch: `best-sellers`, `new-releases`, `press-awards`, `editor-picks`, `most-featured`
+> + `genre_id` - _optional_ : The genre ID to filter the recommandations by.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/album/getFeatured?app_id=100000000&type=new-releases&genre_id=64&limit=2
+
+**Return**
+
+```json
+{
+ "albums": {
+ "offset": 0,
+ "limit": 2,
+ "total": 34,
+ "items": [
+ {
+ "id": "0801061023034",
+ "title": "Until The Quiet Comes",
+ "released_at": 1350856800,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0801/0801061023034_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0801/0801061023034_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0801/0801061023034_50.jpg"
+ },
+ "artist": {
+ "id": 291266,
+ "name": "Flying Lotus"
+ }
+ },
+ {
+ "id": "5051083066389",
+ "title": "Rave Age",
+ "released_at": 1352070000,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/5051/5051083066389_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/5051/5051083066389_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/5051/5051083066389_50.jpg"
+ },
+ "artist": {
+ "id": 396611,
+ "name": "Vitalic"
+ }
+ }
+ ]
+ }
+}
+```
View
74 endpoints/album/search.md
@@ -0,0 +1,74 @@
+# Album Service : search
+
+ GET album/search
+
+## Description
+
+Search for albums by name. Return album matches sorted by relevance.
+
+> NB : This method is a common wrapper for the search/getResults method for `type=albums`
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `query` - _required_ : The term to search for.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/album/search?app_id=100000000&query=John%20Cage&limit=2
+
+**Return**
+
+```json
+{
+ "query": "John Cage",
+ "albums": {
+ "limit": 2,
+ "offset": 0,
+ "total": 243,
+ "items": [
+ {
+ "id": "3760058360279",
+ "title": "John Cage : Sonatas & Interludes",
+ "released_at": 1335132000,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/3760/3760058360279_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/3760/3760058360279_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/3760/3760058360279_50.jpg"
+ },
+ "artist": {
+ "id": null,
+ "name": "Cédric Pescia"
+ }
+ },
+ {
+ "id": "5029365928427",
+ "title": "Music for an Aquatic Ballet - Music for Carillon n°6",
+ "released_at": 1341871200,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/5029/5029365928427_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/5029/5029365928427_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/5029/5029365928427_50.jpg"
+ },
+ "artist": {
+ "id": null,
+ "name": "Roberto Fabbriciani"
+ }
+ }
+ ]
+ }
+}
+```
View
47 endpoints/article/get.md
@@ -0,0 +1,47 @@
+# Article Service : get
+
+ GET article/get
+
+## Description
+
+('Article' as detailed here denotes a post in the magazine)
+
+Get details for an article.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `article_id` - _required_ : The ID of an article
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/article/get?app_id=100000000&article_id=12263
+
+**Return**
+
+```json
+{
+ "id": 12263,
+ "title": "Justice : coup marketing ou vidéo coup de poing ?",
+ "description": "",
+ "published_at": 1210778880,
+ "abstract": "<p class=\"spip\">Marketing épisode 66241. Où comment faire monter la mayonnaise en deux clicks de souris… Pour illustrer le nouveau single, <i>Stress</i>, extrait de son premier album plébiscité aux quatre coins du monde, le tandem electro français <b>Justice</b> a posté sur le net une nouvelle vidéo ultra-violente de plus de six minutes, réalisée par Romain Gavras, le fils du cinéaste Costa Gavras, mettant en scène des jeunes de banlieue cagoulés et vêtus de blousons avec une grande croix noire (le visuel de <b>Justice</b>), s'amusant à semer la terreur sur leur passage. </p>",
+ "content": "<p class=\"spip\">Selon Gaspard Augé et Xavier de Rosnay, ce clip vise à susciter des questions et non à véhiculer un message raciste ou à inciter à la violence. <i>« Ce film n'a jamais été envisagé comme une stigmatisation de la banlieue, comme une incitation à la violence ou, surtout, comme un moyen larvé de véhiculer un message raciste »</i> ont déclaré les deux musiciens.</p>\r\n\r\n<p class=\"spip\"><i>Orange mécanique</i> du pauvre ? Simple coup de pub ? Véritable pamphlet social ? Faites-vous votre propre opinion.</p>\r\n\r\n\r\n<p class=\"spip\"><object width=\"425\" height=\"355\"><param name=\"movie\" value=\"http://www.youtube.com/v/zOP0IECS2FY&hl=en\"></param><param name=\"wmode\" value=\"transparent\"></param><embed src=\"http://www.youtube.com/v/zOP0IECS2FY&hl=en\" type=\"application/x-shockwave-flash\" wmode=\"transparent\" width=\"425\" height=\"355\"></embed></object>\r\n</p>",
+ "url": "http://www.qobuz.com/info/Qobuz-info/Video-du-jour/Justice-coup-marketing-ou-video12263",
+ "author": "Marc Zisman",
+ "source": "Qobuz",
+ "category": "VIDÉO DU JOUR",
+ "image": "http://www.qobuz.com/info/IMG/arton12263.jpg"
+}
+```
View
63 endpoints/article/listLastRubrics.md
@@ -0,0 +1,63 @@
+# Article Service : listLastArticles
+
+ GET article/listLastArticles
+
+## Description
+
+('Article' as detailed here denotes a post in the magazine)
+
+Lists the last articles in the specified rubrics; If no rubric is specified, last articles from all rubrics are returned.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `rubric_ids` - _optional_ : The ID of one or several rubrics
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/article/listLastArticles?app_id=100000000&rubric_ids=12&limit=2
+
+**Return**
+
+```json
+{
+ "articles": {
+ "limit": 2,
+ "offset": 0,
+ "total": 2,
+ "items": [
+ {
+ "id": 132682,
+ "title": "Ludwig van Beethoven <small>Sonates pour piano et violon (intégrale)</small>",
+ "description": "",
+ "published_at": 1342640612,
+ "url": "http://www.qobuz.com/info/MAGAZINE-CRITIQUES/LE-REPERTOIRE-DES-CD-DE-A-A-Z/Ludwig-van-Beethoven-Sonates-pour132682",
+ "author": "Eric Taver",
+ "category": "LE RÉPERTOIRE DES CD DE A À Z",
+ "image": "http://www.qobuz.com/info/IMG/arton132682.jpg"
+ },
+ {
+ "id": 127584,
+ "title": "Franz Schubert <small>Quatuors n°13 \"Rosamunde\", n°14 \"La Jeune Fille et la Mort\", n°15</small>",
+ "description": "",
+ "published_at": 1342087695,
+ "url": "http://www.qobuz.com/info/MAGAZINE-CRITIQUES/LE-REPERTOIRE-DES-CD-DE-A-A-Z/Franz-Schubert-Quatuors-no13127584",
+ "author": "Éric Taver",
+ "category": "LE RÉPERTOIRE DES CD DE A À Z",
+ "image": "http://www.qobuz.com/info/IMG/arton127584.jpg"
+ }
+ ]
+ }
+}
+```
View
66 endpoints/article/listRubrics.md
@@ -0,0 +1,66 @@
+# Article Service : listRubrics
+
+ GET article/listRubrics
+
+## Description
+
+('Article' as detailed here denotes a post in the magazine)
+
+Get the list of available rubrics (i.e. categories).
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `extra` - _optional_ : provides extra details for the rubric, such as articlesCount (the number of articles in the rubric)
+
+> NB : the `extra` parameter is experimental and can be removed without notice
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/article/listRubrics?app_id=100000000&limit=3
+
+**Return**
+
+```json
+{
+ "rubrics": {
+ "limit": 3,
+ "offset": 0,
+ "total": 3,
+ "items": [
+ {
+ "id": 1,
+ "title": "Edito",
+ "description": "",
+ "updated_at": 1354037555,
+ "url": "/info/-Qobuz-info/Edito1"
+ },
+ {
+ "id": 4,
+ "title": "RENCONTRES",
+ "description": "",
+ "updated_at": 1354037555,
+ "url": "/info/-Qobuz-info/Rencontres4"
+ },
+ {
+ "id": 7,
+ "title": "SUR SCÈNE",
+ "description": "",
+ "updated_at": 1354037555,
+ "url": "/info/-Qobuz-info/Sur-scene7"
+ }
+ ]
+ }
+}
+```
View
48 endpoints/artist/get.md
@@ -0,0 +1,48 @@
+# Artist Service : get
+
+ GET artist/get
+
+## Description
+
+Return the metadata for an artist.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `artist_id` - _required_ : The artist ID to fetch the metadata of.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/artist/get?app_id=100000000&artist_id=38994
+
+**Return**
+
+```json
+{
+ "id": 38994,
+ "name": "Midnight Juggernauts",
+ "slug": "midnight-juggernauts",
+ "image": {
+ "small": "http://userserve-ak.last.fm/serve/34s/12119115.jpg",
+ "medium": "http://userserve-ak.last.fm/serve/64s/12119115.jpg",
+ "large": "http://userserve-ak.last.fm/serve/126s/12119115.jpg",
+ "extralarge": "http://userserve-ak.last.fm/serve/252/12119115.jpg",
+ "mega": "http://userserve-ak.last.fm/serve/_/12119115/Midnight+Juggernauts+Taken+from+Flickr.jpg"
+ },
+ "biography": {
+ "summary": "Midnight Juggernauts est un groupe indie-electro-synth originaire de Melbourne, Australie. Il est composé de Streetcrimes (Andy), Vendetta (Vincent) et Strictmachine (Daniel). Leur premier album, Dystopia, est sorti le 4 août 2007 (en Australie). La production soignée de cet album a l'éclat d'une aurore australe, véritable signature du groupe, à voir la pochette. \n Vincent, du groupe, cite Electric Light Orchestra parmi les influences qui ont forgé leur son, notamment sur Into The Galaxy.",
+ "content": "<p>Midnight Juggernauts est un groupe indie-electro-synth originaire de Melbourne, Australie. Il est composé de Streetcrimes (Andy), Vendetta (Vincent) et Strictmachine (Daniel).</p>\n \n<p> Leur premier album, Dystopia, est sorti le 4 août 2007 (en Australie). </p>\n \n<p> La production soignée de cet album a l'éclat d'une aurore australe, véritable signature du groupe, à voir la pochette. \n Vincent, du groupe, cite Electric Light Orchestra parmi les influences qui ont forgé leur son, notamment sur Into The Galaxy.\n Dans la même veine, Midnight Juggernauts révèle son penchant pour la dance music avec un goût \"rétro\" très prononcé. \n Mais là où Scissors Sisters lorgnait vers la disco et les premiers Bee Gees, Midnight Juggernauts a un point de vue sensiblement différent, cherchant l'inspiration dans l'Euro-Disco, les prods de Gorgio Moroder (Italie), du jeune David Bowie (Angleterre), et plus généralement dans les thèmes futuristes, sirupeux et synthétiques des années 80, mêlés à l'harmonie vocale des Beach Boys. \n Le trio australien démontre ainsi sa capacité à combiner un son disco, scintillant comme une étoile filante, à une ligne de basse provocante. Il délivre de cette façon une interprétation électro aussi mature et élégante que le groupe Air. Leurs paroles sont toutefois différentes du duo français, et en cela plus proches de Scissor Sisters dans leur habileté à écrire de vraies chansons pop et à les exprimer avec éloquence. Voire grandiloquence.\n Peu de groupes, en définitive, semblent aussi clairs dans leurs intentions. Surtout après un seul album... \n To be continued...</p>"
+ }
+}
+```
View
59 endpoints/artist/getSimilarArtists.md
@@ -0,0 +1,59 @@
+# Artist Service : getSimilarArtists
+
+ GET artist/getSimilarArtists
+
+## Description
+
+Return similar artists for an artist.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `artist_id` - _required_ : The artist ID to find the similar artists of.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/artist/getSimilarArtists?app_id=100000000&artist_id=118680&limit=3
+
+**Return**
+
+```json
+{
+ "artists": {
+ "limit": 3,
+ "offset": 0,
+ "total": 3,
+ "items": [
+ {
+ "id": 403888,
+ "slug": "arctic-monkeys",
+ "name": "Arctic Monkeys",
+ "picture": "http://userserve-ak.last.fm/serve/126s/63861827.png"
+ },
+ {
+ "id": 53199,
+ "slug": "franz-ferdinand",
+ "name": "Franz Ferdinand",
+ "picture": "http://userserve-ak.last.fm/serve/126s/155921.jpg"
+ },
+ {
+ "id": 655417,
+ "slug": "tame-impala",
+ "name": "Tame Impala",
+ "picture": "http://userserve-ak.last.fm/serve/126s/48746419.jpg"
+ }
+ ]
+ }
+}
+```
View
54 endpoints/artist/search.md
@@ -0,0 +1,54 @@
+# Artist Service : search
+
+ GET artist/search
+
+## Description
+
+Search for artists by name. Return artist matches sorted by relevance.
+
+> NB : This method is a common wrapper for the search/getResults method for `type=artists`
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `query` - _required_ : The term to search for.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/artist/search?app_id=100000000&query=MGMT&limit=2
+
+**Return**
+
+```json
+{
+ "query": "MGMT",
+ "artists": {
+ "limit": 2,
+ "offset": 0,
+ "total": 4,
+ "items": [
+ {
+ "id": 118680,
+ "name": "MGMT",
+ "slug": "mgmt"
+ },
+ {
+ "id": 510963,
+ "name": "Just Blaze for F.O.B. Ent./N.Q.C. Mgmt, LLC",
+ "slug": "just-blaze-for-f-o-b-ent-n-q-c-mgmt-llc"
+ }
+ ]
+ }
+}
+```
View
40 endpoints/favorite/create.md
@@ -0,0 +1,40 @@
+# Favorite Service : create
+
+ GET favorite/create
+
+## Description
+
+Create favorites.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__ and a __valid user_auth_token__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `artist_ids` - _optional_ : List of artist_ids to add to favorites
+> + `album_ids` - _optional_ : List of album_ids to add to favorites
+> + `track_ids` - _optional_ : List of track_ids to add to favorites
+
+Either `artist_ids`, `album_ids` or `track_ids` is required.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/favorite/create?app_id=100000000&album_ids=0060253723059&user_auth_token=MyAuThTokEn
+
+**Return**
+
+```json
+{
+ "status": "success"
+}
+```
View
40 endpoints/favorite/delete.md
@@ -0,0 +1,40 @@
+# Favorite Service : delete
+
+ GET favorite/delete
+
+## Description
+
+Delete favorites.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__ and a __valid user_auth_token__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `artist_ids` - _optional_ : List of artist_ids to add to favorites
+> + `album_ids` - _optional_ : List of album_ids to add to favorites
+> + `track_ids` - _optional_ : List of track_ids to add to favorites
+
+Either `artist_ids`, `album_ids` or `track_ids` is required.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/favorite/delete?app_id=100000000&album_ids=0060253723059&user_auth_token=MyAuThTokEn
+
+**Return**
+
+```json
+{
+ "status": "success"
+}
+```
View
75 endpoints/favorite/getUserFavorites.md
@@ -0,0 +1,75 @@
+# Favorite Service : getUserFavorites
+
+ GET favorite/getUserFavorites
+
+## Description
+
+Return the authenticated user or specified user_id favorites filtered by item type.
+
+> NB : The favorites are inherently public.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `user_id` - _optional_ : The User ID to fetch the favorites from
+> + `type` - _optional_ : The favorites type (`tracks`, `albums`, `artists`).
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/favorite/getUserFavorites?app_id=100000000&limit=2&type=albums&user_auth_token=MyAuThTokEn
+
+**Return**
+
+```json
+{
+ "albums": {
+ "offset": 0,
+ "limit": 2,
+ "total": 16,
+ "items": [
+ {
+ "id": "0060253723059",
+ "title": "Trilogy",
+ "released_at": 1352674800,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0060/0060253723059_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0060/0060253723059_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0060/0060253723059_50.jpg"
+ },
+ "artist": {
+ "id": 687008,
+ "name": "The Weeknd"
+ }
+ },
+ {
+ "id": "0060253716442",
+ "title": "Kanye West Presents Good Music Cruel Summer",
+ "released_at": 1348869600,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0060/0060253716442_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0060/0060253716442_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0060/0060253716442_50.jpg"
+ },
+ "artist": {
+ "id": 145383,
+ "name": "Various Artists"
+ }
+ }
+ ]
+ }
+}
+```
View
39 endpoints/genre/get.md
@@ -0,0 +1,39 @@
+# Genre Service : get
+
+ GET genre/get
+
+## Description
+
+Get details for a genre of music.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `genre_id` - _required_ : The ID of a genre
+
+> NB : `extra` parameter is now deprecated
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/genre/get?app_id=100000000&genre_id=64
+
+**Return**
+
+```json
+{
+ "id": 64,
+ "name": "Electro",
+ "slug": "electro"
+}
+```
View
87 endpoints/genre/list.md
@@ -0,0 +1,87 @@
+# Genre Service : list
+
+ GET genre/list
+
+## Description
+
+Lists all the sub-genres of a parent genre of music. If parent_id is omitted, all the root level genres are returned.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `parent_id` - _optional_ : The ID of a genre.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/genre/list?app_id=100000000&parent_id=64
+
+**Return**
+
+```json
+{
+ "genres": {
+ "parent": {
+ "id": "64",
+ "level": "1",
+ "slug": "electro",
+ "name": "Electro"
+ },
+ "limit": 100,
+ "offset": 0,
+ "total": 8,
+ "items": [
+ {
+ "id": 65,
+ "name": "Ambiant",
+ "slug": "ambiant"
+ },
+ {
+ "id": 66,
+ "name": "Downtempo",
+ "slug": "downtempo"
+ },
+ {
+ "id": 67,
+ "name": "Drum & Bass",
+ "slug": "drum-bass"
+ },
+ {
+ "id": 68,
+ "name": "House",
+ "slug": "house"
+ },
+ {
+ "id": 69,
+ "name": "Lounge",
+ "slug": "lounge"
+ },
+ {
+ "id": 70,
+ "name": "Techno",
+ "slug": "techno"
+ },
+ {
+ "id": 71,
+ "name": "Trance",
+ "slug": "trance"
+ },
+ {
+ "id": 72,
+ "name": "Trip Hop",
+ "slug": "trip-hop"
+ }
+ ]
+ }
+}
+```
View
40 endpoints/label/get.md
@@ -0,0 +1,40 @@
+# Label Service : get
+
+ GET label/get
+
+## Description
+
+Get details for a music label.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `label_id` - _required_ : The ID of a label
+
+> NB : `extra` parameter is now deprecated
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/label/get?app_id=100000000&label_id=11937
+
+**Return**
+
+```json
+{
+ "id": 11937,
+ "name": "[PIAS]Recordings",
+ "slug": "pias-recordings-1",
+ "description": "<p>C'est en 1982 que, l'histoire de Play It Again Sam commence, lorsque Kenny GATES, étudiant, pousse la porte du Casablanca Moon Record Shop, un magasin de disque basé en Belgique et tenu par Michel LAMBOT. Les deux hommes, passionnés de musique, décident alors de créer une entreprise ayant pour vocation d'améliorer la production, la distribution et la promotion de musiques nouvelles et non commerciales. A cela, il convient d'ajouter une volonté de restaurer l'image des musiciens belges à l'étranger et de leur permettre de se développer de façon internationale. Leur projet se matérialise en 1983 par la création d'une S.A.R.L., pourvue d'un capital initial de 20 000 francs français et appelée Play It Again Sam, nom inspiré d'un dialogue tiré du film Casablanca de Michael Curtiz.</p>\r\n\r\n [ ... ] \r\n\r\n<p>[PIAS] France aborde le XXIe siècle en gardant sa philosophie et en s'imposant comme l'un des principaux acteurs indépendants du marché du disque. Les découvertes et les succès continuent de s'enchainer : avec chez Rough Trade la sortie des albums des Libertines et d'Antony & The Johnsons, Cocorosie chez Touch & Go, la re-signature de Domino et la découverte d'artistes comme The Kills, Franz Ferdinand et Arctic Monkeys, la montée en puissance du label Ninja Tune avec notamment le succès de Bonobo mais aussi la signature avec Back Yard Recordings et la sortie du « Standing In The Way Of Control » de The Gossip. La production d'artistes locaux continue avec Vitalic, Villeneuve, The Hacker, Agoria et bien sur Miossec qui enchaine les réussites notamment les albums « L'étreinte » et « Finistériens ». L'avenir de [PIAS] France passe par plusieurs objectifs : les [PIAS] Nites dont la première à Bruxelles a regroupé 8000 spectateurs le 26 mars dernier, le lancement du label [PIAS] Recordings France avec en premières signatures The Chase et Oh Là Là et la volonté de faire de la société un média destiné à faire découvrir les nouveaux artistes.</p>"
+}
+```
View
70 endpoints/label/list.md
@@ -0,0 +1,70 @@
+# Label Service : list
+
+ GET label/list
+
+## Description
+
+Lists all the labels available on Qobuz.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/label/list?app_id=100000000&limit=5&offset=1340
+
+**Return**
+
+```json
+{
+ "labels": {
+ "limit": 5,
+ "offset": 1340,
+ "total": 5,
+ "items": [
+ {
+ "id": 4769,
+ "name": "Altess Music",
+ "slug": "altess-music",
+ "description": null
+ },
+ {
+ "id": 3017,
+ "name": "altipiani",
+ "slug": "altipiani",
+ "description": null
+ },
+ {
+ "id": 25977,
+ "name": "Altis Productions",
+ "slug": "altis-productions",
+ "description": null
+ },
+ {
+ "id": 15317,
+ "name": "Altissimo",
+ "slug": "altissimo",
+ "description": null
+ },
+ {
+ "id": 15677,
+ "name": "Altraiz 64",
+ "slug": "altraiz-64",
+ "description": null
+ }
+ ]
+ }
+}
+```
View
39 endpoints/playlist/addTracks.md
@@ -0,0 +1,39 @@
+# Playlist Service : addTracks
+
+ GET playlist/addTracks
+
+## Description
+
+Add tracks in the playlist queue. Require playlist owner authentication except if the playlist is public and collaborative.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+If you wish to add tracks to a playlist that is not public, a __valid user_auth_token is required__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `playlist_id` - _required_ : The playlist ID to add the tracks to.
+> + `track_ids` - _optional_ : Comma-separated, ordered list of track IDs.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/addTracks?app_id=100000000&playlist_id=213676&track_ids=123454,1453536&user_auth_token=MyUsErToKeN
+
+**Return**
+
+```json
+{
+ "status": "success"
+}
+```
View
52 endpoints/playlist/create.md
@@ -0,0 +1,52 @@
+# Playlist Service : create
+
+ GET playlist/create
+
+## Description
+
+Create a playlist on behalf of the authenticated user. Return the created playlist in case of success.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__ and __a valid user_auth_token__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `name` - _required_ : Name for the playlist.
+> + `description` - _optional_ : Description for the playlist.
+> + `is_public` - _optional_ : Flag to make the playlist public.
+> + `is_collaborative` - _optional_ : Flag to make the playlist collaborative.
+> + `track_ids` - _optional_ : Initial tracks to add to the playlist.
+> + `album_id` - _optional_ : Initial album to add to the playlist.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/create?app_id=100000000&name=superPlaylist&description=Fantastic&is_public=1&is_collaborative=0&user_auth_token=MyUsErToKeN
+
+**Return**
+
+```json
+{
+ "id": 213677,
+ "name": "superPlaylist",
+ "description": "Fantastic",
+ "position": null,
+ "created_at": 1354016710,
+ "updated_at": 1354016710,
+ "is_public": true,
+ "is_collaborative": false,
+ "owner": {
+ "id": 12345,
+ "name": "loris"
+ }
+}
+```
View
36 endpoints/playlist/delete.md
@@ -0,0 +1,36 @@
+# Playlist Service : delete
+
+ GET playlist/delete
+
+## Description
+
+Delete a playlist. Require playlist owner authentication.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__ and __a valid user_auth_token__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _required_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `playlist_id` - _required_ : The playlist ID to delete.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/delete?app_id=100000000&playlist_id=213677&user_auth_token=MyUsErToKeN
+
+**Return**
+
+```json
+{
+ "status": "success"
+}
+```
View
39 endpoints/playlist/deleteTracks.md
@@ -0,0 +1,39 @@
+# Playlist Service : deleteTracks
+
+ GET playlist/deleteTracks
+
+## Description
+
+Delete tracks from the playlist. Require playlist owner authentication except if the playlist is public and collaborative.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+If you wish to delete tracks from a playlist that is not public and collaborative, a __valid user_auth_token is required__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+> + `playlist_id` - _required_ : The playlist ID to delete the tracks from.
+> + `playlist_track_ids` - _optional_ : Comma-separated list of playlist track IDs to delete.
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/deleteTracks?app_id=100000000&playlist_id=213676&playlist_track_ids=12323456,123456,234567,4567890&user_auth_token=MyUsErToKeN
+
+**Return**
+
+```json
+{
+ "status": "success"
+}
+```
View
149 endpoints/playlist/get.md
@@ -0,0 +1,149 @@
+# Playlist Service : get
+
+ GET playlist/get
+
+## Description
+
+Get the metadata for a playlist, including tracks and subscribers.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+If you wish to get a private playlist belonging to a user, a __valid user_auth_token is required__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `playlist_id` - _required_ : The playlist ID to fetch the metadata of.
+> + `extra` - _optional_ : Extra fields to include in the response (comma-separated) : `tracks`, ...
+> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/get?app_id=100000000&playlist_id=49806&extra=tracks&limit=2
+
+**Return**
+
+```json
+{
+ "id": 49806,
+ "name": "Electro/Rock (Oct. '12)",
+ "description": "",
+ "position": null,
+ "created_at": 1318098968,
+ "updated_at": 1352032549,
+ "is_public": true,
+ "is_collaborative": false,
+ "owner": {
+ "id": 4350,
+ "name": "loris"
+ },
+ "tracks": {
+ "offset": 0,
+ "limit": 4,
+ "total": 29,
+ "items": [
+ {
+ "id": 6439035,
+ "title": "Hello Inc. (DJ Falcon Remix)",
+ "track_number": 2,
+ "media_number": 1,
+ "duration": 244,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 40876,
+ "name": "Alex Gopher"
+ },
+ "performers": "Alex Gopher, Performer\r - Alexis Latrobe, Composer\r - Philippe Thuillier, Composer\r - Stéphane Queme, Composer",
+ "version": null,
+ "copyright": "2012 Go4music",
+ "work": null,
+ "album": {
+ "id": "3700551740024",
+ "title": "Hello Inc. (feat. Saint Michel) - EP",
+ "released_at": 1349647200,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/3700/3700551740024_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/3700/3700551740024_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/3700/3700551740024_50.jpg",
+ "back": null
+ },
+ "artist": {
+ "id": 40876,
+ "name": "Alex Gopher"
+ },
+ "label": {
+ "id": 1221,
+ "name": "Go 4 Music"
+ },
+ "genre": {
+ "id": 64,
+ "name": "Electro"
+ },
+ "description": null,
+ "url": "http://www.qobuz.com/album/hello-inc-feat-saint-michel-ep-alex-gopher/3700551740024"
+ },
+ "playlist_track_id": 10796364,
+ "position": 1,
+ "created_at": 1351946933
+ },
+ {
+ "id": 5230493,
+ "title": "The Recipe",
+ "track_number": 1,
+ "media_number": 1,
+ "duration": 352,
+ "streamable": true,
+ "purchasable": true,
+ "performer": {
+ "id": 617741,
+ "name": "Kendrick Lamar"
+ },
+ "performers": "Kendrick Lamar, Artist\r - Dr. Dre, Featured Artist",
+ "version": null,
+ "copyright": "(P) 2012 Aftermath/Interscope Records",
+ "work": null,
+ "album": {
+ "id": "0060253701094",
+ "title": "The Recipe",
+ "released_at": 1333576800,
+ "purchasable": true,
+ "image": {
+ "large": "http://static.qobuz.com/images/jaquettes/0060/0060253701094_600.jpg",
+ "small": "http://static.qobuz.com/images/jaquettes/0060/0060253701094_230.jpg",
+ "thumbnail": "http://static.qobuz.com/images/jaquettes/0060/0060253701094_50.jpg",
+ "back": null
+ },
+ "artist": {
+ "id": 617741,
+ "name": "Kendrick Lamar"
+ },
+ "label": {
+ "id": 25373,
+ "name": "Aftermath - Interscope Records"
+ },
+ "genre": {
+ "id": 133,
+ "name": "Rap - Hip Hop"
+ },
+ "description": null,
+ "url": "http://www.qobuz.com/album/the-recipe-kendrick-lamar/0060253701094"
+ },
+ "playlist_track_id": 10796365,
+ "position": 2,
+ "created_at": 1351946933
+ }
+ ]
+ }
+}
+```
View
68 endpoints/playlist/getPublicPlaylists.md
@@ -0,0 +1,68 @@
+# Playlist Service : getPublicPlaylists
+
+ GET playlist/getPublicPlaylists
+
+## Description
+
+Return a list of public playlists.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `type` - _optional_ : The query type, ie. `last-created`, ...
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/getPublicPlaylists?app_id=100000000&type=last-created&limit=2
+
+**Return**
+
+```json
+{
+ "playlists": {
+ "offset": 0,
+ "limit": 2,
+ "items": [
+ {
+ "id": 211892,
+ "name": "Mahler: Lieder eines fahrenden Gesellen; Kindertotenlieder; 4 Rückert-Lieder | Gustav Mahler par Dietrich Fischer-Dieskau",
+ "description": "",
+ "position": null,
+ "created_at": 1353828688,
+ "updated_at": 1353828689,
+ "is_public": true,
+ "is_collaborative": false,
+ "owner": {
+ "id": 930,
+ "name": "delbanof"
+ }
+ },
+ {
+ "id": 211891,
+ "name": "Vivaldi: Concerti per fagotto III | Compositeurs Divers par Sergio Azzolini",
+ "description": "",
+ "position": null,
+ "created_at": 1353828439,
+ "updated_at": 1353828440,
+ "is_public": true,
+ "is_collaborative": false,
+ "owner": {
+ "id": 595,
+ "name": "Anubis58"
+ }
+ }
+ ]
+ }
+}
+```
View
75 endpoints/playlist/getUserPlaylists.md
@@ -0,0 +1,75 @@
+# Playlist Service : getUserPlaylists
+
+ GET playlist/getUserPlaylists
+
+## Description
+
+Get both public and private playlists of the authenticated user.
+
+> NB : Return only public playlists of the user if the request is not authenticated.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__
+
+If you wish to get the private playlists of a user, a __valid user_auth_token is required__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))
+> + `user_id` - _optional_ : The user ID to fetch the playlists of.
+> + `username` - _optional_ : Alternatively, its username.
+> + `user_auth_token` - _optional_ : The authenticated user token (see [User authentication](https://github.com/Qobuz/api-documentation#user-auth))
+
+***
+
+## Example
+**Request**
+
+ http://www.qobuz.com/api.json/0.2/playlist/getUserPlaylists?app_id=100000000&username=loris&limit=2
+
+**Return**
+
+```json
+{
+ "playlists": {
+ "offset": 0,
+ "limit": 2,
+ "total": 31,
+ "items": [
+ {
+ "id": 213654,
+ "name": "fat",
+ "description": "",
+ "position": 0,
+ "created_at": 1354011415,
+ "updated_at": 1354011415,
+ "is_public": true,
+ "is_collaborative": false,
+ "owner": {
+ "id": 4350,
+ "name": "loris"
+ }
+ },
+ {
+ "id": 34225,
+ "name": "dance dance revolution",
+ "description": null,
+ "position": 0,
+ "created_at": 1307112433,
+ "updated_at": 1353328495,
+ "is_public": true,
+ "is_collaborative": false,
+ "owner": {
+ "id": 378,
+ "name": "blanchedelaforce"
+ }
+ }
+ ]
+ }
+}
+```
View
36 endpoints/playlist/subscribe.md
@@ -0,0 +1,36 @@
+# Playlist Service : subscribe
+
+ GET playlist/subscribe
+
+## Description
+
+Subscribe the authenticated user to the playlist.
+
+***
+
+## Requires authentication
+
+__Requires a valid app_id__ and a __valid user_auth_token__.
+
+***
+
+## Parameters
+
+> + `app_id` - _required_ : Your Application ID (see [Application authentication](https://github.com/Qobuz/api-documentation#application-auth))