Get Catalog Charts
Fetch one or more charts from the Apple Music Catalog.
URL
GET https://api.music.apple.com/v1/catalog/{storefront}/chartsPath Parameters
| Name | Type | Description |
|---|---|---|
storefront Required | string | An iTunes Store territory, specified by an ISO 3166 alpha-2 country code. The possible values are the |
Query Parameters
| Name | Type | Description |
|---|---|---|
types Required | [string] | A list of the types of charts to include in the results. The possible values are |
l Optional | string | The localization to use, specified by a language tag. The possible values are in the |
chart Optional | string | The chart to fetch for the specified types. For possible values, get all the charts by sending this endpoint without the chart parameter. The possible values for this parameter are the |
genre Optional | string | The identifier for the genre to use in the chart results. |
limit Optional | integer | The number of objects or number of objects in the specified relationship returned. |
offset Optional | string | The next page or group of objects to fetch. |
with Optional | [string] | The request modifiers for fetching non-standard charts collections. The value |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ChartResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect |
| 500 | Internal Server Error Content-Type: application/json | ErrorsResponse | A response indicating an error occurred on the server. |
Discussion
If successful, the HTTP status code is 200 (OK) and the response contains an object where results contains chart collections. The members for the collections are the chart types in the request and the values are Chart objects. The data member of each Chart object contains an array of the corresponding resource ordered by popularity. For example, if the request contains the songs chart type, the object contains a songs member with a value that is a Chart object containing Song objects. This may be a paginated response. For more information, see Fetch Resources by Page.
If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. For more information, see Handling Requests and Responses.