2025-10-13 15:20:20 +00:00
|
|
|
# ``APIProtocol``
|
|
|
|
|
|
|
|
|
|
## Topics
|
|
|
|
|
|
|
|
|
|
### Service endpoints
|
|
|
|
|
|
|
|
|
|
- ``APIProtocol/getService(_:)``
|
|
|
|
|
- ``APIProtocol/getService(headers:)``
|
|
|
|
|
|
2025-10-13 17:55:48 +00:00
|
|
|
### Authentication endpoints
|
|
|
|
|
|
|
|
|
|
- ``APIProtocol/getRequestToken(_:)``
|
|
|
|
|
- ``APIProtocol/getRequestToken(headers:)``
|
|
|
|
|
- ``APIProtocol/postAccessToken(_:)``
|
|
|
|
|
- ``APIProtocol/postAccessToken(headers:)``
|
|
|
|
|
- ``APIProtocol/getUserIdentity(_:)``
|
|
|
|
|
- ``APIProtocol/getUserIdentity(headers:)``
|
|
|
|
|
|
2025-10-13 15:20:20 +00:00
|
|
|
### Database endpoints
|
|
|
|
|
|
|
|
|
|
- ``APIProtocol/searchDatabase(_:)``
|
|
|
|
|
- ``APIProtocol/searchDatabase(query:headers:)``
|
|
|
|
|
- ``APIProtocol/getArtist(_:)``
|
|
|
|
|
- ``APIProtocol/getArtist(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getArtistReleases(_:)``
|
|
|
|
|
- ``APIProtocol/getArtistReleases(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getLabel(_:)``
|
|
|
|
|
- ``APIProtocol/getLabel(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getLabelReleases(_:)``
|
|
|
|
|
- ``APIProtocol/getLabelReleases(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getMaster(_:)``
|
|
|
|
|
- ``APIProtocol/getMaster(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getMasterVersions(_:)``
|
|
|
|
|
- ``APIProtocol/getMasterVersions(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getRelease(_:)``
|
|
|
|
|
- ``APIProtocol/getRelease(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getReleaseRating(_:)``
|
|
|
|
|
- ``APIProtocol/getReleaseRating(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getReleaseRatingByUser(_:)``
|
|
|
|
|
- ``APIProtocol/getReleaseRatingByUser(path:headers:)``
|
|
|
|
|
- ``APIProtocol/putReleaseRatingByUser(_:)``
|
|
|
|
|
- ``APIProtocol/putReleaseRatingByUser(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/deleteReleaseRatingByUser(_:)``
|
|
|
|
|
- ``APIProtocol/deleteReleaseRatingByUser(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getReleaseStats(_:)``
|
|
|
|
|
- ``APIProtocol/getReleaseStats(path:headers:)``
|
2025-10-16 14:38:41 +00:00
|
|
|
|
2025-11-10 01:23:24 +01:00
|
|
|
### User Identity endpoints
|
2025-10-16 14:38:41 +00:00
|
|
|
|
|
|
|
|
- ``APIProtocol/getUserProfile(_:)``
|
|
|
|
|
- ``APIProtocol/getUserProfile(path:headers:)``
|
|
|
|
|
- ``APIProtocol/postUserProfile(_:)``
|
|
|
|
|
- ``APIProtocol/postUserProfile(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getUserContributions(_:)``
|
|
|
|
|
- ``APIProtocol/getUserContributions(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getUserSubmissions(_:)``
|
|
|
|
|
- ``APIProtocol/getUserSubmissions(path:headers:)``
|
|
|
|
|
|
2025-11-10 01:23:24 +01:00
|
|
|
### User Collection endpoints
|
2025-10-16 14:38:41 +00:00
|
|
|
|
|
|
|
|
- ``APIProtocol/getCollectionFolders(_:)``
|
|
|
|
|
- ``APIProtocol/getCollectionFolders(path:headers:)``
|
|
|
|
|
- ``APIProtocol/postCollectionFolders(_:)``
|
|
|
|
|
- ``APIProtocol/postCollectionFolders(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getCollectionFolder(_:)``
|
|
|
|
|
- ``APIProtocol/getCollectionFolder(path:headers:)``
|
|
|
|
|
- ``APIProtocol/postCollectionFolder(_:)``
|
|
|
|
|
- ``APIProtocol/postCollectionFolder(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/deleteCollectionFolder(_:)``
|
|
|
|
|
- ``APIProtocol/deleteCollectionFolder(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getCollectionItemsByRelease(_:)``
|
|
|
|
|
- ``APIProtocol/getCollectionItemsByRelease(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getCollectionItemsByFolder(_:)``
|
|
|
|
|
- ``APIProtocol/getCollectionItemsByFolder(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/postReleaseToCollectionFolder(_:)``
|
|
|
|
|
- ``APIProtocol/postReleaseToCollectionFolder(path:headers:)``
|
|
|
|
|
- ``APIProtocol/postChangeRatingOfRelease(_:)``
|
|
|
|
|
- ``APIProtocol/postChangeRatingOfRelease(path:query:headers:body:)``
|
|
|
|
|
- ``APIProtocol/deleteInstanceFromCollectionFolder(_:)``
|
|
|
|
|
- ``APIProtocol/deleteInstanceFromCollectionFolder(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getCustomFields(_:)``
|
|
|
|
|
- ``APIProtocol/getCustomFields(path:headers:)``
|
|
|
|
|
- ``APIProtocol/editFieldsInstance(_:)``
|
|
|
|
|
- ``APIProtocol/editFieldsInstance(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getCollectionValue(_:)``
|
2025-10-16 16:24:46 +00:00
|
|
|
- ``APIProtocol/getCollectionValue(path:headers:)``
|
|
|
|
|
|
2025-11-10 01:23:24 +01:00
|
|
|
### User Wantlist endpoints
|
2025-10-16 16:24:46 +00:00
|
|
|
|
|
|
|
|
- ``APIProtocol/getWantlist(_:)``
|
|
|
|
|
- ``APIProtocol/getWantlist(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/addToWantlist(_:)``
|
|
|
|
|
- ``APIProtocol/addToWantlist(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/updateInWantlist(_:)``
|
|
|
|
|
- ``APIProtocol/updateInWantlist(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/deleteFromWantlist(_:)``
|
|
|
|
|
- ``APIProtocol/deleteFromWantlist(path:headers:)``
|
2025-10-16 17:33:15 +00:00
|
|
|
|
2025-11-10 01:23:24 +01:00
|
|
|
### User Lists endpoints
|
2025-10-16 17:33:15 +00:00
|
|
|
|
|
|
|
|
- ``APIProtocol/getLists(_:)``
|
|
|
|
|
- ``APIProtocol/getLists(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getList(_:)``
|
2025-11-10 01:23:24 +01:00
|
|
|
- ``APIProtocol/getList(path:headers:)``
|
|
|
|
|
|
|
|
|
|
### Marketplace endpoints
|
|
|
|
|
|
|
|
|
|
- ``APIProtocol/getInventory(_:)``
|
|
|
|
|
- ``APIProtocol/getInventory(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/getListing(_:)``
|
|
|
|
|
- ``APIProtocol/getListing(path:query:headers:)``
|
|
|
|
|
- ``APIProtocol/createListing(_:)``
|
|
|
|
|
- ``APIProtocol/createListing(headers:body:)``
|
|
|
|
|
- ``APIProtocol/editListing(_:)``
|
|
|
|
|
- ``APIProtocol/editListing(path:headers:body:)``
|
|
|
|
|
- ``APIProtocol/deleteListing(_:)``
|
|
|
|
|
- ``APIProtocol/deleteListing(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getOrders(_:)``
|
|
|
|
|
- ``APIProtocol/getOrders(query:headers:)``
|
|
|
|
|
- ``APIProtocol/getOrder(_:)``
|
|
|
|
|
- ``APIProtocol/getOrder(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getOrderMessages(_:)``
|
|
|
|
|
- ``APIProtocol/getOrderMessages(path:headers:)``
|
|
|
|
|
- ``APIProtocol/addOrderMessage(_:)``
|
|
|
|
|
- ``APIProtocol/addOrderMessage(path:headers:body:)``
|
|
|
|
|
- ``APIProtocol/getFee(_:)``
|
|
|
|
|
- ``APIProtocol/getFee(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getFeeWithCurrency(_:)``
|
|
|
|
|
- ``APIProtocol/getFeeWithCurrency(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getPriceSuggestions(_:)``
|
|
|
|
|
- ``APIProtocol/getPriceSuggestions(path:headers:)``
|
|
|
|
|
- ``APIProtocol/getStatistics(_:)``
|
|
|
|
|
- ``APIProtocol/getStatistics(path:query:headers:)``
|