Oud API Documentation (1.0.1)

Download OpenAPI specification:Download

License: Apache 2.0

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.

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Artists

Endpoints for artists

Get an Artist

Authorizations:
path Parameters
artistId
required
string

The ID for the artist.

Responses

200

the response body contains an artist object in JSON format.

400

Invalid ID

404

Not Found - The requested resource could not be found.

get /artists/{artistId}
/artists/{artistId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "genres":
    [
    ],
  • "images":
    [
    ],
  • "displayName": "string",
  • "bio": "string",
  • "popularSongs":
    [
    ],
  • "type": "string"
}

Gets artists of a specific genre

Authorizations:
path Parameters
id
required
string

The ID of the genre.

Responses

200

the response body contains a list of artist objects in JSON format.

400

Invalid ID

404

Not Found - The requested resource could not be found.

get /artists/genres/{id}
/artists/genres/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get an Artist's Albums

Authorizations:
path Parameters
artistId
required
string

The ID for the artist.

query Parameters
limit
integer
Default: 20

The number of album objects to return. Minimum: 1. Maximum: 50. For example: limit=2

offset
integer
Default: 0

The index of the first album to return. (0 is the first album). Use with limit to get the next set of albums.

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:

  • album
  • single
  • appears_on
  • compilation' For example: include_groups=album,single.

Responses

200

The response body contains an array of simplified album objects (wrapped in a paging object) in JSON format.

400

Invalid ID

404

Not Found - The requested resource could not be found.

get /artists/{artistId}/albums
/artists/{artistId}/albums

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "items":
    [
    ],
  • "limit": 0,
  • "offset": 0,
  • "total": 0
}

Get an Artist's Top Tracks

Get information about an artist’s top tracks by views.

Authorizations:
path Parameters
artistId
required
string

The ID for the artist.

Responses

200

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.

400

Invalid ID

404

Not Found - The requested resource could not be found.

get /artists/{artistId}/top-tracks
/artists/{artistId}/top-tracks

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tracks":
    [
    ]
}

Get an Artist's Related Artists

Get information about artists similar to a given artist. Similarity is based on genre.

Authorizations:
path Parameters
artistId
required
string

The ID for the artist.

Responses

200

the response body contains an object whose key is "artists" and whose value is an array of up to 20 artist objects in JSON format.

400

Invalid ID

404

Not Found - The requested resource could not be found.

get /artists/{artistId}/related-artists
/artists/{artistId}/related-artists

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "artists":
    [