Endpoints
Search albums
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 relationships to include. Includes are only one level deep. Valid values depend on the endpoint.
view?string
Apply the same view to the main resource and included relationships.
Value in
"minimal"view[albums]?string
View mode for albums.
Value in
"minimal"view[artists]?string
View mode for artists.
Value in
"minimal"view[songs]?string
View mode for songs.
Value in
"minimal"limit?integer
Page size.
Default
25Range
1 <= value <= 25offset?integer
Number of items to skip.
Default
0Range
0 <= valuefilter[genres]?string
Comma-separated genres filter.
limit[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/albums?term=string"{
"data": [
{
"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"
}
}
}
]
}
}
]
}
}
],
"meta": {
"limit": 0,
"offset": 0,
"has_next_page": true
}
}{
"error": {
"code": 0,
"title": "string",
"message": "string",
"trace_id": "string"
}
}