⚠️
DEPRECATED
This repository is no longer maintained. You can still use a REST client like Requests or other third-party Python library to access the Discogs REST API.
Discogs API Client
This is the official Discogs API client for Python. It enables you to query the Discogs database for information on artists, releases, labels, users, Marketplace listings, and more. It also supports OAuth 1.0a authorization, which allows you to change user data such as profile information, collections and wantlists, inventory, and orders.
Installation
Install the client from PyPI using your favorite package manager.
$ pip install discogs_client
Quickstart
Instantiating the client object
>>> import discogs_client
>>> d = discogs_client.Client('ExampleApplication/0.1')
Authorization (optional)
There are a couple of different authorization methods you can choose from depending on your requirements.
OAuth authentication
This method will allow your application to make requests on behalf of any user who logs in.
For this, specify your app's consumer key and secret:
>>> d.set_consumer_key('key-here', 'secret-here')
>>> # Or you can do this when you instantiate the Client
Then go through the OAuth 1.0a process. In a web app, we'd specify a callback_url. In this example, we'll use the OOB flow.
>>> d.get_authorize_url()
('request-token', 'request-secret', 'authorize-url-here')
The client will hang on to the access token and secret, but in a web app, you'd want to persist those and pass them into a new Client instance on the next request.
Next, visit the authorize URL, authenticate as a Discogs user, and get the verifier:
>>> d.get_access_token('verifier-here')
('access-token-here', 'access-secret-here')
Now you can make requests on behalf of the user.
>>> me = d.identity()
>>> "I'm {0} ({1}) from {2}.".format(me.name, me.username, me.location)
u"I'm Joe Bloggs (example) from Portland, Oregon."
>>> len(me.wantlist)
3
>>> me.wantlist.add(d.release(5))
>>> len(me.wantlist)
4
User-token authentication
This is one of the simplest ways to authenticate and become able to perform requests requiring authentication, such as search (see below). The downside is that you'll be limited to the information only your user account can see (i.e., no requests on behalf of other users).
For this, you'll need to generate a user-token from your developer settings on the Discogs website.
>>> d = discogs_client.Client('ExampleApplication/0.1', user_token="my_user_token")
Fetching data
Use methods on the client to fetch objects. You can search for objects:
>>> results = d.search('Stockholm By Night', type='release')
>>> results.pages
1
>>> artist = results[0].artists[0]
>>> artist.name
u'Persuader, The'
Or fetch them by ID:
>>> artist.id
1
>>> artist == d.artist(1)
True
You can drill down as far as you like.
>>> releases = d.search('Bit Shifter', type='artist')[0].releases[1].\
... versions[0].labels[0].releases
>>> len(releases)
134
Artist
Query for an artist using the artist's name:
>>> artist = d.artist(956139)
>>> print artist
<Artist "...">
>>> 'name' in artist.data.keys()
True
Special properties
Get a list of Artists representing this artist's aliases:
>>> artist.aliases
[...]
Get a list of Releases by this artist by page number:
>>> artist.releases.page(1)
[...]
Release
Query for a release using its Discogs ID:
>>> release = d.release(221824)
Special properties
Get the title of this Release:
>>> release.title
u'...'
Get a list of all Artists associated with this Release:
>>> release.artists
[<Artist "...">]
Get the tracklist for this Release:
>>> release.tracklist
[...]
Get the MasterRelease for this Release:
>>> release.master
<MasterRelease "...">
Get a list of all Labels for this Release:
>>> release.labels
[...]
MasterRelease
Query for a master release using its Discogs ID:
>>> master_release = d.master(120735)
Special properties
Get the key Release for this MasterRelease:
>>> master_release.main_release
<Release "...">
Get the title of this MasterRelease:
>>> master_release.title
u'...'
>>> master_release.title == master_release.main_release.title
True
Get a list of Releases representing other versions of this MasterRelease by page number:
>>> master_release.versions.page(1)
[...]
Get the tracklist for this MasterRelease:
>>> master_release.tracklist
[...]
Label
Query for a label using the label's name:
>>> label = d.label(6170)
Special properties
Get a list of Releases from this Label by page number:
>>> label.releases.page(1)
[...]
Get a list of Labels representing sublabels associated with this Label:
>>> label.sublabels
[...]
Get the Label's parent label, if it exists:
>>> label.parent_label
<Label "Warp Records Limited">
Contributing
- Fork this repo
- Create a feature branch
- Open a pull-request
For more information
Check the included documentation, or just spin up a REPL and use dir() on things :)
2 Jul 22, 2022
3 Nov 12, 2021
7.9k Jan 02, 2023
2 Jul 22, 2022
72 Aug 22, 2022
46 Dec 23, 2022
56 Dec 22, 2022
57 Nov 08, 2022
24 Dec 09, 2022
23 Oct 21, 2022
6 Apr 02, 2022
7 May 01, 2022
207 Dec 05, 2022
204 Dec 28, 2022
2 Dec 18, 2021
8 Nov 18, 2022
1 Nov 04, 2021
47 Oct 31, 2022
4 Dec 30, 2022
6 Dec 18, 2022