Skip to content

Global JSON Objects

Tonkku edited this page Mar 16, 2023 · 21 revisions

Artist Object

Field Type Description
ActiveYears array of integers Years when the artist has released on Monstercat
Details.About string The artist's bio
Details.Bookings string Details about artist's bookings
Details.ManagementDetails string Details about artist's management
FeaturedReleaseCoverFileId ?string File ID for the cover of the featured release
FeaturedReleaseId ?string ID of artist's featured release
FeaturedVideoURL ?string URL to artist's featured video
Id string Artist's unique id
LandscapeFileId ?string File ID for landscape
Links array of link objects Links to the artist's socials
LogoFileId ?string File ID for logo
Name string Artist's name
PortraitFileId ?string File ID for portrait
ProfileFileId ?string File ID for artist profile picture
Public boolean Whether the artist's profile page is public
ShowEvent boolean Whether events should be shown
SquareFileId ?string File ID for square
Tags array of strings The tags for the artist
URI string Public url slug to the artist's profile page

Link Object

Field Type Description
Url string The url this link leads to
Platform string The platform this link leads to

Playlist Object

Field Type Description
Archived boolean Whether the playlist is archived
BackgroundFileId string ID of the background image asset
CreatedAt ISO8601 timestamp When the playlist was created
Description string The description of the playlist
Id string The unique ID of the playlist
IsPublic boolean Whether the playlist is public
Items null The items in the playlist (always null)
MyLibrary boolean Whether this is a user's library
NumRecords integer The amount of tracks in the playlist
TileFileId string ID of the tile image asset
Title string The title of the playlist
UpdatedAt ISO8601 timestamp When the playlist was last updated
UserId string The ID of the user who owns the playlist

Playlist Item Object

Field Type Description
PlaylistId string The ID of the playlist this item belongs to
ReleaseId string The ID of the release the track belongs to
Sort integer The index of the item in the playlist
TrackId string The ID of the track this item refers to

Release Object

Field Type Description
AlbumNotes? string Liner Notes for the release
Artists? ?array of release artist objects Artists for the release
ArtistsTitle string Human readable artists string
BrandId? integer The ID of the brand the release belongs to
BrandTitle? string Human readable name of the brand the release belongs to
CatalogId string The catalog ID of the release. After Dec 1, 2022 the UPC is used
CopyrightPLine? string Notice of sound recording copyright (℗)
Description string Description of the release
Downloadable? boolean Whether the release can be downloaded with Gold
FeaturedArtistsTitle? string Human readable featured artists (unused?)
GRid? string The Global Release Identifier of the release
GenrePrimary? string Primary genre of the release
GenreSecondary? string The subgenre of the release
Id string The unique ID of the release
InEarlyAccess? boolean Whether the release is currently in Gold Early Access
Links? ?array of link objects Links on this release
PrereleaseDate? ?ISO8601 timestamp The pre-release date
PresaveDate? ?ISO8601 timestamp The date when the release went up for presave
ReleaseDate ISO8601 timestamp The release date
ReleaseDateTimezone string Timezone identifier for the release date
SpotifyId? ?string The spotify id for the release (see Links instead)
Streamable? boolean Whether the release can be streamed on the site/player
Tags? ?array of strings The tags of the release
Title string The title of the release
Tracks? null Tracks in the release (unused)
Type string The type of the release (Single, EP, Album, etc)
UPC? string The Universal Product Code code of the release
Version string The version of the release (shown in parentheses)
YoutubeUrl? ?string The youtube video for the release (see Links instead)

Track Object

Field Type Description
Artists array of track artist objects The artists that produced the track
ArtistsTitle string Human readable artists string
BPM integer The track's BPM
Brand string The brand the track belongs to
BrandId integer The ID of the brand
CreatorFriendly boolean Whether the track is available for Content Creator licenses
DebutDate ISO8601 timestamp The first release date of the track
Downloadable boolean Whether the track can be downloaded with Gold
Duration integer The duration of the track in seconds
Explicit boolean Whether the track is explicit
File? file object A file associated with the track. Used for extended mixes
GenrePrimary string Primary genre of the track
GenreSecondary string The subgenre of the track
ISRC string The International Standard Recording Code of the track
Id string The unique ID of the track
InEarlyAccess boolean Whether the track is currently in Gold Early Access
PlaylistSort? integer The index of the track in a playlist
Release release object The release the track belongs to
Streamable boolean Whether the track can be streamed on the site/player
Tags ?array of strings The tags for the track
Title string The title of the track
TrackNumber integer The track number of the track in a release
Version string The version of the track (shown in parentheses)

Release Artist Object

Field Type Description
ArtistId string Artist's unique id
ArtistNumber integer Artist's order in release credit
Name string Artist's name
ProfileFileId string ID of the profile image asset
Platform string Artist platform?
Public boolean Whether the artist's profile page is public
ReleaseId string ID of the release this artist is linked to
Role string Artist's role in the release
URI string Public url slug to the artist's profile page

Track Artist Object

Field Type Description
CatalogRecordId string ID of the track this artist is linked to
Id string Artist's unique id
Name string Artist's name
ProfileFileId string ID of the profile image asset
Public boolean Whether the artist's profile page is public
Role string Artist's role in the release
URI string Public url slug to the artist's profile page

Settings object

Field Type Description
AutoEnableStreamerMode boolean Automatically enable creator safe mode when streaming (Streamlabs)
BlockUnlicensableTracks boolean Block unlicensable tracks from playing (creator safe mode)
HideUnlicensableTracks boolean Hide unlicensable tracks from view (creator safe mode)
StreamerMode? boolean Shortcut to set both creator safe mode settings at once
PlaylistPublicDefault boolean Make new playlists public by default
PreferredFormat string Format used to download tracks
SaySong? boolean Allows viewers to use the !song command in chat
AutoSaySong? boolean Automatically display the currently playing song in chat

User object

Field Type Description
Archived boolean Has the user been archived
Attributes.events boolean Get "Event announcements & info" notifications
Attributes.goldPerks boolean Get "Future gold updates & features" notifications
Attributes.merch boolean Get "Shop discounts & promotions" notifications
Attributes.news boolean Get "Monstercat news and special offers" notifications
AutoSaySong boolean Automatically display the currently playing song in chat
Birthday? ISO8601 timestamp User's birthday
City? string User's city
Continent? string user's continent
Country? string User's country
CreatedAt ISO8601 timestamp When the user's account was created
Email string User's email
EmailVerificationStatus string User's email verification status
Features array Unknown array about features the user has
FirstName string User's first name
FreeGold boolean Whether the user has a free gold subscription
FreeGoldAt ISO8601 timestamp When the user was granted free gold
FreeGoldReason string The reason the user has been granted free gold
GivenDownloadAccess boolean Whether the user has download access outside of gold
GoogleMapsPlaceId string Google maps ID for the user's location
HasDownload boolean Whether the user has download access
HasGold boolean Whether the user has gold
HasPassword boolean Whether the user has set a password
Id string ID of the user
LastName? string User's last name
LastSeen ISO8601 timestamp Last time the user has used the site
LastUpdateBenefitsGold boolean Unknown
LocationLat double Latitude of the user's location
LocationLng double Longitude of the user's location
MaxLicenses integer Maximum amount of licenses the user has
MyLibrary string ID of the user's My Library playlist
PlaceName string The name of the user's location
PlaceNameFull string The full name of the user's location
PlayerUUID string ID of the user's player for the Streaming Widget
Pronouns? string User's pronouns
ProvSt? string User's province or state
ProvinceState? string User's province or state
SaySong boolean Allows viewers to use the !song command in chat
Score ? Unknown
Settings settings object User's saved settings for the player
TwoFactorId? string ID of the Authy 2FA
TwoFactorPendingId? string ID of the Authy 2FA that is pending verification
UpdatedAt ISO8601 timestamp When the user was last updated
Username string User's username

File object

Field Type Description
CreatedAt ISO8601 timestamp When the file was created
Deleted boolean Whether the file has been deleted
Filename string Name of the file
Filepath string Path to the file
Id string ID of the file
LastAction string The last action that was performed
LastMessage string Message associated with the last action
LastStatus string The status of the last action
LastUser string ID of the User that performed the last action
MimeType string MIME type of the file
Statuses null Unknown

Error object

Field Type Description
Errors null There are currently no known cases where this is populated
Message string Error message
Name string Name of the error
StatusCode integer HTTP status code for the error
Clone this wiki locally