Skip to content
Tonkku edited this page Jul 30, 2022 · 6 revisions

Browse Catalog

GET /catalog/browse

Browse and search tracks in the catalog.

Query String Params

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

Response

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

GET /catalog/filters

Responds with dropdown values for the catalog browser.

Response

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

Brand Object

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 latest releases

GET /catalog/latest-releases

Browse recently released releases

Query String Params

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

Response

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
Clone this wiki locally