Core.rq_wantlist is a collection of function wrappers around the Discogs API for interacting with the wantlist of a given user.

get_user_wantlist[source]

get_user_wantlist(user:Union[UserWithoutAuthentication, UserWithUserTokenBasedAuthentication], username:str, page:Optional[int]=None, per_page:Optional[int]=None)

Get a list of releases from the wantlist for the given user.

Note: If the wantlist has been made private by its owner, you must be authenticated as the owner to view it.

No user Authentication needed.

Parameters:

user: user object (required)

username: string (required) -> The username of the wantlist you are trying to fetch.

page: number (optional) -> The page you want to request.

per_page: number (optional) -> The number of items per page.

# Example for usage of get_user_wantlist
get_user_wantlist(user=example_user, 
                  username="discogspy", 
                  page=1, 
                  per_page=3)
<Response [200]>

add_release_to_wantlist[source]

add_release_to_wantlist(user:UserWithUserTokenBasedAuthentication, username:str, release_id:int, notes:Optional[str]=None, rating:Optional[int]=None)

Add a releases to the wantlist of the given user.

User Authentication needed.

Parameters:

user: user object (required)

username: string (required) -> The username of the wantlist you are trying to fetch.

release_id: number (required) -> The ID of the release you are adding.

notes: string (optional) -> User notes to associate with this release.

rating: number (optional) -> User’s rating of this release, from 0 (unrated) to 5 (best). Defaults to 0.

# Example for add_release_to_wantlist
add_release_to_wantlist(user=example_user, 
                        username="discogspy", 
                        release_id=1995816, 
                        notes="perfect album", 
                        rating=5)
<Response [201]>

change_notes_of_a_release_from_wantlist[source]

change_notes_of_a_release_from_wantlist(user:UserWithUserTokenBasedAuthentication, username:str, release_id:int, notes:str)

Change the notes of a releases from the wantlist for the given user.

User Authentication needed.

Parameters:

user: user object (required)

username: string (required) -> The username of the wantlist you are trying to fetch.

release_id: number (required) -> The ID of the release you are modifying.

notes: string (required) -> Updated user notes to associate with this release.

# Example for change_notes_of_a_release_from_wantlist
change_notes_of_a_release_from_wantlist(user=example_user, 
                                        username="discogspy", 
                                        release_id=1995816, 
                                        notes="one of the greatest albums of all time")
<Response [200]>

change_rating_of_a_release_from_wantlist[source]

change_rating_of_a_release_from_wantlist(user:UserWithUserTokenBasedAuthentication, username:str, release_id:int, rating:int)

Change the rating of a releases from the wantlist of the given user.

User Authentication needed.

Parameters:

user: user object (required)

username: string (required) -> The username of the wantlist you are trying to fetch.

release_id: number (required) -> The ID of the release you are modifying.

rating: number (optional) -> Updated user rating of this release, from 0 (unrated) to 5 (best). Defaults to 0.

# Example for change_rating_of_a_release_from_wantlist
change_rating_of_a_release_from_wantlist(user=example_user, 
                                         username="discogspy", 
                                         release_id=1995816, 
                                         rating=5)
<Response [200]>

delete_release_from_wantlist[source]

delete_release_from_wantlist(user:UserWithUserTokenBasedAuthentication, username:str, release_id:int)

Delete a releases from the wantlist of the given user.

User Authentication needed.

Parameters:

user: user object (required)

username: string (required) -> The username of the wantlist you are trying to fetch.

release_id: number (required) -> The ID of the release you are deleting.

# Example for delete_release_from_wantlist
delete_release_from_wantlist(user=example_user, 
                             username="discogspy", 
                             release_id=1995816)
<Response [204]>