Download OpenAPI specification:Download
Web API endpoints enable application to access the Oud catalog and user data. The endpoints are arranged in a structure defined by an object model.
artistId required | string The ID for the artist. |
the response body contains an artist object in JSON format.
Invalid ID
Not Found - The requested resource could not be found.
{- "_id": "string",
- "genres": [
- {
- "_id": "string",
- "name": "string"
}
], - "images": [
- "string"
], - "displayName": "string",
- "bio": "string",
- "popularSongs": [
- {
- "_id": "string",
- "name": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "albumId": "string",
- "album": {
- "_id": "string",
- "album_type": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "image": "string",
- "name": "string",
- "type": "string",
- "released": true
}, - "type": "string",
- "duartion": 0,
- "views": 0
}
], - "type": "string"
}
id required | string The ID of the genre. |
the response body contains a list of artist objects in JSON format.
Invalid ID
Not Found - The requested resource could not be found.
[- {
- "_id": "string",
- "genres": [
- {
- "_id": "string",
- "name": "string"
}
], - "images": [
- "string"
], - "displayName": "string",
- "bio": "string",
- "popularSongs": [
- {
- "_id": "string",
- "name": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "albumId": "string",
- "album": {
- "_id": "string",
- "album_type": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "image": "string",
- "name": "string",
- "type": "string",
- "released": true
}, - "type": "string",
- "duartion": 0,
- "views": 0
}
], - "type": "string"
}
]
artistId required | string The ID for the artist. |
limit | integer Default: 20 The number of album objects to return. Minimum: 1. Maximum: 50. For example: |
offset | integer Default: 0 The index of the first album to return. (0 is the first album). Use with |
included_groups | string A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are:
|
The response body contains an array of simplified album objects (wrapped in a paging object) in JSON format.
Invalid ID
Not Found - The requested resource could not be found.
{- "items": [
- {
- "_id": "string",
- "album_type": "string",
- "album_group": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "image": "string",
- "name": "string",
- "type": "string",
- "released": true
}
], - "limit": 0,
- "offset": 0,
- "total": 0
}
Get information about an artist’s top tracks by views.
artistId required | string The ID for the artist. |
the response body contains an object whose key is "tracks"
and whose value is an array of up to 10 track objects in JSON format.
Invalid ID
Not Found - The requested resource could not be found.
{- "tracks": [
- {
- "_id": "string",
- "name": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "albumId": "string",
- "album": {
- "_id": "string",
- "album_type": "string",
- "artists": [
- {
- "_id": "string",
- "displayName": "string",
- "type": "string",
- "images": [
- "string"
]
}
], - "image": "string",
- "name": "string",
- "type": "string",
- "released": true
}, - "type": "string",
- "duartion": 0,
- "views": 0
}
]
}