GetUsersTopArtistsRequest (spotify-web-api-java 2.3.0 API)

java.lang.Object
- de.sonallux.spotify.api.apis.personalization.GetUsersTopArtistsRequest

```
public class GetUsersTopArtistsRequest
extends Object
```
Get a User's Top Artists request
Required OAuth scopes
user-top-read
Response

On success, the HTTP status code in the response header is 200 OK and the response body contains a paging object of Artists. On error, the header status code is an error code and the response body contains an error object.

Constructor Summary

Constructors
Constructor Description

GetUsersTopArtistsRequest(ApiClient apiClient)
Get a User's Top Artists request

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApiCall<Paging<Artist>>`	`build()`	Build the request into an executable call
`GetUsersTopArtistsRequest`	`limit(int limit)`	The number of entities to return.
`GetUsersTopArtistsRequest`	`offset(int offset)`	The index of the first entity to return.
`GetUsersTopArtistsRequest`	`timeRange(String timeRange)`	Over what time frame the affinities are computed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GetUsersTopArtistsRequest
```
public GetUsersTopArtistsRequest(ApiClient apiClient)
```
    Get a User's Top Artists request
    
    Parameters:
    
    apiClient -
    The API client
- Method Detail
  - timeRange
```
public GetUsersTopArtistsRequest timeRange(String timeRange)
```
    Over what time frame the affinities are computed. Valid values: long_term (calculated from several years of data and including all new data as it becomes available), medium_term (approximately last 6 months), short_term (approximately last 4 weeks). Default: medium_term
  - limit
```
public GetUsersTopArtistsRequest limit(int limit)
```
    The number of entities to return. Default: 20. Minimum: 1. Maximum: 50. For example: limit=2
  - offset
```
public GetUsersTopArtistsRequest offset(int offset)
```
    The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.
  - build
```
public ApiCall<Paging<Artist>> build()
```
    Build the request into an executable call