-
Notifications
You must be signed in to change notification settings - Fork 0
Catalog
Tonkku edited this page Jul 30, 2022
·
6 revisions
GET /catalog/browse
Browse and search tracks in the catalog.
| Field | Type | Default | Description |
|---|---|---|---|
| limit? | integer | 100 | Amount of tracks to return (max 100) |
| offset? | integer | 0 | Amount of tracks to skip |
| search? | string | N/A | The search terms |
| sort? | string | -date | Field to sort by. Prefix with - for descending |
| nogold? | boolean | false | Whether to hide tracks in Gold Early Access |
| streamerMode? | boolean | false | Whether streamer mode is enabled or not |
| brands? | array of integers | N/A | Brand IDs to filter for |
| genres? | array of strings | N/A | Genres to filter for |
| types? | array of strings | N/A | Release types to filter for |
| tags? | array of strings | N/A | Tags to filter for |
| creatorFriendly? | boolean | N/A | Whether to filter for creator safe or unsafe tracks |
| releaseId? | string | N/A | Filter for tracks in a specific release |
| artistId? | string | N/A | Filter for tracks released by a specific artist |
| Field | Type | Description |
|---|---|---|
| Data | array of track objects | The results of the query |
| Limit | integer | The limit used |
| NotFound | null | Unused in this endpoint |
| Offset | integer | The offset used |
| Total | integer | The total amount of results for the search |
GET /catalog/filters
Responds with dropdown values for the catalog browser.
| Field | Type | Description |
|---|---|---|
| Brands | array of brand objects | Brand options |
| Genres | array of strings | Genre options |
| Tags | array of strings | Tag options |
| Types | array of strings | Type options |
| Field | Type | Description |
|---|---|---|
| Active | boolean | Whether the brand is active |
| Id | integer | The ID of the brand |
| Title | string | The name of the brand |
GET /catalog/latest-releases
Browse recently released releases
| Field | Type | Default | Description |
|---|---|---|---|
| limit? | integer | 100 | Amount of releases to return (max 100) |
| offset? | integer | 0 | Amount of releases to skip |
| sort? | string | -date | Field to sort by. Prefix with - for descending |
| creatorFriendly? | boolean | N/A | Whether to filter for creator safe or unsafe releases |
| Field | Type | Description |
|---|---|---|
| Data | array of release objects | The results of the query |
| Limit | integer | The limit used |
| Offset | integer | The offset used |
| Total | integer | The total amount of results for the search |
- Home
- Global objects
- Catalog
- Releases
- Playlists
- Artists
-
Me
- Get user info
- Change user info
- Change settings
- Get player code
- Regenerate player code
- Change email
- Change password
- Enable SMS 2FA (deprecated)
- Confirm SMS 2FA (deprecated)
- Disable SMS 2FA (deprecated)
- Enable TOTP 2FA
- Get TOTP QR Code
- Disable TOTP 2FA
- Enable Email 2FA
- Disable Email 2FA
- Change notifications
- Get licenses
- Remove license
- Remove video claims
- Generate discount code
- Authentication
- CDX
- TODO