This endpoint is now deprecated. Please use the new endpoint Get charts entries.
GET /api/v2/album/{slug}/charts/ranks/{platform}
Parameter name | Value | Description | Additional |
---|---|---|---|
slug | string | An album slug |
Required |
platform | string | A album chart platform code |
Required |
Parameter name | Value | Description | Additional |
---|---|---|---|
currentOnly | integer | Get only the current positions in charts with 1, or the current and past positions with 0. |
|
offset | integer | Get results starting from position |
|
limit | integer | Number of results (max. 100) |
|
sortBy | string | Sort criteria. Available values are : position, rankDate |
|
sortOrder | string | Sort order. Available values are : asc, desc |
Status code | Description | Resource |
---|---|---|
200 | OK
A album rank collection response |
Album Rank Collection |
400 | Bad Request
Invalid request |
|
401 | Unauthorized
You are not logged in |
|
403 | Forbidden
This endpoint is not included in your current plan, reach out to help@soundcharts.com if you want access. |
|
404 | Not Found
Album not found |