Logo

Docs

Endpoints

Get popular station

GET
/stations/popular

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[stations]?string

View mode for stations.

Value in"minimal"
view[songs]?string

View mode for songs.

Value in"minimal"
limit[tracks]?integer

Limit included tracks.

Range1 <= value <= 25

Response Body

application/json

application/json

curl -X GET "http://localhost:8080/api/stations/popular"
{
  "data": {
    "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": [
                          {
                            "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": {},
                            "relationships": {}
                          }
                        ],
                        "songs": [
                          {
                            "id": "string",
                            "type": "songs",
                            "meta": {},
                            "instance": {
                              "files": []
                            },
                            "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": {},
                            "instance": {
                              "files": []
                            },
                            "relationships": {}
                          }
                        ],
                        "artists": [
                          {
                            "id": "string",
                            "type": "artists",
                            "meta": {},
                            "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"
            }
          }
        }
      ]
    }
  }
}
{
  "error": {
    "code": 0,
    "title": "string",
    "message": "string",
    "trace_id": "string"
  }
}