Skip to content
aknorw edited this page Jun 21, 2019 · 3 revisions

Inventory

const options = {
  username,
  status,
  pagination,
  sort,
}

client.getInventory(options)
param required type -
options false object See below
key required type default -
username true string -
status false string - Must be All, Deleted, Draft, Expired, For Sale, Sold, Suspended or Violation
pagination false object - See paginate
sort false object - See sort - by listed (default), price, item, artist, label, catno, audio, status or location

See on Discogs API documentation

Identity

Get identity

client.getIdentity()

See on Discogs API documentation

Profile

See on Discogs API documentation

Get profile

client.getProfile(username)
param required type -
username true string

Edit profile

const data = {
  name,
  homepage,
  location,
  profile,
  currency,
}

client.editProfile(username, data)
param required type -
username true string
data true object See below
key required type default -
name false string -
homepage false string -
location false string -
profile false string -
currency false string - Must be a supported currency

Submissions

client.getSubmissionsForUser(username, pagination)
param required type -
username true string
pagination false object See paginate

See on Discogs API documentation

Contributions

client.getContributionsForUser(username, pagination, sort)
param required type -
username true string
pagination false object See paginate
sort false object See sort - by label (default), artist, title, catno, format, rating, year or added

See on Discogs API documentation

Collection

Folders

List folders

client.listFoldersForUser(username)
param required type -
username true string

See on Discogs API documentation

Get folder

client.getFolderForUser(username, folderId)
param required type -
username true string
folderId true int

See on Discogs API documentation

Edit folder

client.editFolderForUser(username, folderId, name)
param required type -
username true string
folderId true int
name true string

See on Discogs API documentation

Remove folder

client.removeFolderForUser(username, folderId)
param required type -
username true string
folderId true int

See on Discogs API documentation

Create folder

client.createFolderForUser(username, name)
param required type -
username true string
name true string

See on Discogs API documentation

Get items in folder

client.getItemsInFolderForUser(username, folderId, pagination, sort)
param required type -
username true string
folderId true int
pagination false object See paginate
sort false object See sort - by label, artist, title, catno, format, rating, year or added

See on Discogs API documentation

Custom fields

client.getCustomFields(username)
param required type -
username true string

See on Discogs API documentation

Collection value

client.getValue(username)
param required type -
username true string

See on Discogs API documentation

Wantlist

Get wantlist

client.getWantlist(username, pagination)
param required type -
username true string
pagination false object See paginate

See on Discogs API documentation

Add to wantlist

const options = {
  username,
  releaseId,
  notes,
  rating,
}

client.addToWantlist(options)
param required type -
options true object See below
key required type default -
username true string -
releaseId true int -
notes false string -
rating false int 0 From 0 to 5

See on Discogs API documentation

Remove from wantlist

client.removeFromWantlist(username, releaseId)
param required type -
username true string
releaseId true int

See on Discogs API documentation

Lists

client.getListsForUser(username, pagination)
param required type -
username true string
pagination false object See paginate

See on Discogs API documentation