Get song ranking (deprecated)
This endpoint is now deprecated. Please use the new Get songs endpoint.
Request
GET
/api/v2/top-song/{platform}/{metricType}
Path parameters
| Parameter | Value | Description | Additional |
|---|---|---|---|
| platform | string | platform code | Required |
| metricType | string | streams, views, videos created, favorites, popularity, plays, likes, count | Required |
Query string parameters
| Parameter | Value | Description | Additional |
|---|---|---|---|
| sortBy | string | total, change, percent | Required |
| period | string | week, month, quarter | Required |
| songCountryCode | string | Song nationality (Country code of 2 letters ISO 3166-2, example: 'US', full list on https://en.wikipedia.org/wiki/ISO_3166-2) | Optional |
| minValue | integer | Total audience (min value) | Optional |
| maxValue | integer | Total audience (max value) | Optional |
| minChange | integer | Change percentage audience (min value) | Optional |
| maxChange | integer | Change percentage audience (max value) | Optional |
| token | string | Page token | Optional |
Response
| Code | Description | Resource |
|---|---|---|
| 200 |
OK
A Top Song response with platform audience, popularity, custom ... for a period |
Song Collection |
| 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. |