Skip to content

REST API SPEC

pmartin7 edited this page Dec 22, 2016 · 1 revision

/genres

Get all music genres currently in the music graph store.

Returns: a list of Genre names

/genre/{genre}/related

Get a list of related music genres for a provided genre name, ordered by relevance between genres

{genre}: a string name of a music genre

Returns: a list of Genre names, and the relevance for each output genre in relation to the input {genre}

/genre/{genre}/artists

Get a list of artists categorized in a specific music genre, ordered by relevance

{genre}: a string name of a music genre

Returns: a list of artists and associated metadata

/artist/{spotifyId}

Get the artist metadata for an artist identified by its SpotifyId

{spotifyId}: a string ID representing the artist spotifyId

Returns: artist metadata for the identified artist

/artist/search?n={name}

Get all artists that match a specific name

{name}: a string name to search artist names

Returns: a list of artists ranked by popularity, and associated artist metadata

/artist/{spotifyId}/related

Get all artists related to a provided artist uniquely identified by its spotifyId

{spotifyId}: a string ID representing the artist spotifyId

Returns: a list of artists related to the artist matching {spotifyId}, ranked by relevance, and associated artist metadata for each artist

/artist/path?from={fromSpotifyId}&to={toSpotifyId}&size={pageSize}

Get the N shortest most relevant paths from an artist to another artist in the graph

{fromSpotifyId}: a string ID representing the artist spotifyId to start from

{toSpotifyId}: a string ID representing the artist spotifyId to end at

{pageSize}: an integer representing how many paths to return

Returns: a list of artist paths going from the source to the target artist, ordered by overall relevance of the connection between artists in the path.

Clone this wiki locally