Logo

Docs

Endpoints

Get albums for an artist

GET
/artists/{id}/rel/albums

Path Parameters

id*string

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"
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"
limit?integer

Page size.

Default25
Range1 <= value <= 25
offset?integer

Number of items to skip.

Default0
Range0 <= value
sort?string

Sort artist albums. Prefix with - for descending.

Value in"name" | "-name" | "date_released" | "-date_released" | "date_added" | "-date_added"
limit[artists]?integer

Limit included artists.

Range1 <= value <= 25

Response Body

application/json

application/json

curl -X GET "http://localhost:8080/api/artists/string/rel/albums"
{
  "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"
  }
}