Endpoints
Search top results
Query Parameters
lang?string
Preferred locale string such as en-US. Implementations may ignore localization, but en-US is the recommended default and fallback.
Default
"en-US"term*string
Search term.
include?string
Comma-separated search buckets to return. Supported values: top, songs, artists, albums, stations, playlists.
view?string
Apply the same view to the main resource and included relationships.
Value in
"minimal"view[songs]?string
View mode for songs.
Value in
"minimal"view[albums]?string
View mode for albums.
Value in
"minimal"view[artists]?string
View mode for artists.
Value in
"minimal"view[playlists]?string
View mode for playlists.
Value in
"minimal"view[stations]?string
View mode for stations.
Value in
"minimal"limit[songs]?integer
Limit included songs.
Range
1 <= value <= 25limit[albums]?integer
Limit included albums.
Range
1 <= value <= 25limit[artists]?integer
Limit included artists.
Range
1 <= value <= 25limit[tracks]?integer
Limit included tracks.
Range
1 <= value <= 25Response Body
application/json
application/json
curl -X GET "http://localhost:8080/api/search?term=string"{
"data": {
"top": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
]
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
]
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
]
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
]
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
]
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
]
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
]
}
}
],
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
]
}
}
]
}
}
],
"stations": [
{
"id": "string",
"type": "stations",
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
null
],
"songs": [
null
]
}
}
]
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
null
],
"artists": [
null
]
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
]
}
}
],
"playlists": [
{
"id": "string",
"type": "playlists",
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{
"download_url": "http://example.com",
"lossless": true,
"mime_type": "string",
"codec": "string",
"bitrate": 0,
"stream_url": "http://example.com"
}
],
"has_lyrics": true
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
null
],
"songs": [
null
]
}
}
]
}
}
],
"artists": [
{
"id": "string",
"type": "artists",
"meta": {
"omm_id": "string"
},
"relationships": {
"albums": [
{
"id": "string",
"type": "albums",
"meta": {
"omm_id": "string"
},
"relationships": {
"tracks": [
null
],
"artists": [
null
]
}
}
],
"songs": [
{
"id": "string",
"type": "songs",
"meta": {
"omm_id": "string"
},
"instance": {
"duration_in_ms": 0,
"files": [
{}
],
"has_lyrics": true
},
"relationships": {}
}
]
}
}
],
"lyrics": {
"text": "string",
"language": "string"
}
}
}
]
}
}
]
}
}{
"error": {
"code": 0,
"title": "string",
"message": "string",
"trace_id": "string"
}
}