STYNGR API
STYNGR API can be used to play licensed music inside of your application by creating many different playlists that end users can choose from, offering radio-like experience by allowing users to choose playlist which suits their taste. Songs are randomly chosen from selected playlist and if end user does not like a certain song, they have an option to skip a song, up to 6 times within one hour period.
Our API endpoints are secured with two kind of JWT tokens with different scopes, which are issued to each end user separately.
What made this section unhelpful for you?
Base URL
Production:
https://api.styngr.com
Staging:
https://stg.api.styngr.com
What made this section unhelpful for you?
Authentication
What made this section unhelpful for you?
Styngs
Styngs are in-game emotes followed by up to 30 seconds long song clips. Users can buy styng which they can bind to an application event. Once the application user triggers an application event, styng can be reproduced, so that nearby players can hear their styng. Styngs can also be preloaded during loading of game session, by pulling binded styngs of each user in that game session.
Application Errors
Allow game developers to send errors messages they have encountered
User Event Tracking
Application Tests
Application Events
Application events are in-game events to which users can bind their Styngs. Example of application events would be a headshot, scored goal or player spawning at the base.
Notifications
Notification APIs for application end user.
Payment Transactions
Payment transactions are created for every product purchase, e.g. Styng, Stynglist or Radio Subscription, with external payment system handling the actual payment processing. Applications that implement Styngr API must use the payment confirmation API in order for user to obtain access to their bought product.
Promo messages
Radio Subscriptions
Radio subscriptions allow user to listen to your application's playlist, without Ads. At the moment, user can choose between following subscription types: Monthly, Stream-count based, or Playback-time based. Monthly subscriptions, as their name suggests, allow users to have an unlimited radio listening experience for thirty days after their subscription purchase. Monthly subscriptions can be renewed at any point in time, while they are in active or pending payment state. Stream-count subscriptions offer a limited number of tracks which users can listen to. Every single request that returns a random track is counted towards this quota. Once the quota is spent, users will have to purchase a new subscription, or they will be back on Ad-funded listening experience if it's available in your application. Playback-time based subscriptions offer a limited number of minutes to which users can listen to. Once the quota is spent, users will have to purchase a new subscription, or they will be back on Ad-funded listening experience.
SDK Users
APIs related to application end users, which allows operations such as in-game currency balance update and addition of Styngs/Stynglists as rewards to users.
Soundboards
Soundboards are collection of chosen styngs for your application that application users can subscribe to and use during their game session. Application can have multiple soundboards but only one published soundboard per source.
Stynglists
Stynglists are collection of Styngs which allows user to buy multiple Styngs more easily.
LSR styngs
LSR styngs are in-game emotes followed by up to 30 seconds long song clips. Users can buy LSR styngs which they can bind to an application event. Once the application user triggers an application event, LSR styngs can be reproduced, so that nearby players can hear their LSR styng. LSR styngs can also be preloaded during loading of game session, by pulling binded LSR styngs of each user in that game session.
styng-statistics-controller
Spotify
Styngr integration with Spotify music platform.
Playlists V3
Royalty free playlists are set of songs that are linked to a single application, which allows users of that application to choose which music they will listen to during their game session. These songs are randomly selected from the playlist, and there is no skip limit for them.
Playlists V2
Playlists are set of songs that are linked to a single application, which allows users of that application to choose which music will they listen to during their game session. Users can skip through songs for up to 6 times during one hour period.
Playlists V2 - API Integration
Playlists are set of songs that are linked to a single application, which allows users of that application to choose which music will they listen to during their game session. Users can skip through songs for up to 6 times during one hour period.
Group sessions - API Integration
Styngr allows users to create a Group Sessions that will allow multiple users to listen to the same tracks at the same time. Group Session API is intended to be used with Playlist API, which means requesting tracks and submitting statistics needs to be performed as for Playlist Sessions for single users. Group Sessions can have two different user types: Owner and Members. Every user can belong only to single Group Session at the time. Every Group Session can have only one Group Session Owner, and multiple Group Session Members. Group Session Owner is responsible for media playback controls, that is, requesting a new track, skipping or pausing the current track. Group Session Members cannot impact listening flow, as they only have to synchronize with Group session Owner's actions. Synchronization between Owner and Members is currently left to implement to applications that are integrating with Styngr API.
What made this section unhelpful for you?
Create a Group Session
Create a new Group Session to which other users can join via Join Group Session API. All users in Group session must have an active subscription. User that created a new Group Session will be linked to the Group Session as a Group Session Owner. Other users that join the Group Session will be linked as Group Session Members.
Header Parameters
Query Parameters
Protocol which should be used to reproduce next track from the playlist. Every track URL is a secure HTTPS link.
HTTP
HLS
HLSE
Boolean flag indicating if track audio asset URL should be created for the next track.
Boolean flag indicating if complete set of territory codes in which track is available should be returned in the response.
Track container format that should be returned. Defaults to AAC.
AAC
MP3
Path Parameters
Playlist ID for which Group Session will be created.
Response
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Response Attributes
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Show child attributes
Show child attributes
What made this section unhelpful for you?
Response
Group Session is successfully created and can be used to request track URLs.
What made this section unhelpful for you?
Get Group Session information
Allows user to get information about Group Session it belongs to. This API should be mainly invoked after the Owner of Group Session leaves to check who is the new Owner of the Group Session.
Header Parameters
Path Parameters
Group Session from which information should be retrieved.
Response
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Response Attributes
Response Attributes
Show child attributes
Show child attributes
What made this section unhelpful for you?
Response
User was successfully removed from the Group Session.
What made this section unhelpful for you?
Change current Playlist for Group Session
Allows Group Session Owner to switch current Playlist. If selected Playlist already have session that session will be used as current Playlist Session, otherwise new Playlist Session will be created and used. Session will be resumed from the last track that was returned in the previous listening.
Header Parameters
Path Parameters
Group Session for which Owner will change current Playlist.
Body Parameters
Response
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Response Attributes
Response Attributes
Show child attributes
Show child attributes
Response Attributes
Show child attributes
Show child attributes
What made this section unhelpful for you?
Response
Current Playlist for Group Session is successfully changed.
What made this section unhelpful for you?
Promote user as Group Session Owner
Allows current owner or game server to promote a Group Session Member as a new Owner.
Header Parameters
Path Parameters
Group Session for which new Owner will be promoted.
Body Parameters
Response
What made this section unhelpful for you?
Response
OK
What made this section unhelpful for you?
Leave Group Session
Allows user to leave a Group Session. This API is mandatory to be called if user is about to switch to a different Group Session, or if they are closing the application/game. Prior to this API call, user must submit playback statistics for the track that is currently playing in the Group Session.
Header Parameters
Path Parameters
Group Session from which User will be removed.
Response
Response Attributes
Response Attributes
What made this section unhelpful for you?
Response
User was successfully removed from the Group Session.
What made this section unhelpful for you?
Join a Group Session
Allows user to join a Group Session as a Group Session Member. User must have an active radio subscription and must not be linked to any other Group Session at the moment of joining a new Group Session.
Header Parameters
Path Parameters
Group Session to which User will join as Group Session Member.
Response
Response Attributes
Response Attributes
What made this section unhelpful for you?
Response
User has successfully joined a Group Session as a Member.
What made this section unhelpful for you?
Group sessions
Styngr allows users to create a Group Sessions that will allow multiple users to listen to the same tracks at the same time. Group Session API is intended to be used with Playlist API, which means requesting tracks and submitting statistics needs to be performed as for Playlist Sessions for single users. Group Sessions can have two different user types: Owner and Members. Every user can belong only to single Group Session at the time. Every Group Session can have only one Group Session Owner, and multiple Group Session Members. Group Session Owner is responsible for media playback controls, that is, requesting a new track, skipping or pausing the current track. Group Session Members cannot impact listening flow, as they only have to synchronize with Group session Owner's actions. Synchronization between Owner and Members is currently left to implement to applications that are integrating with Styngr API.
Statistics
Used for storing song and ad playback statistics.
Playlists
Playlists are set of songs that are linked to a single application, which allows users of that application to choose which music will they listen to during their game session. Users can skip through songs for up to 6 times during one hour period.
Playlists - API Integration
Playlists are set of songs that are linked to a single application, which allows users of that application to choose which music will they listen to during their game session. Users can skip through songs for up to 6 times during one hour period.
Applications
Styngr allows users to get basic information about applications they are using.
radio-info-controller
Roblox
Web3
Styngr SDK API
Styngr API can be used to play licensed music inside of your application by creating many different playlists that end users can choose from, offering radio-like experience by allowing users to choose playlist which suits their taste. Songs are randomly chosen from selected playlist and if end user does not like a certain song, they have an option to skip a song, up to 6 times within one hour period.
Our API endpoints are secured with two kind of JWT tokens with different scopes, which are issued to each end user separately.
What made this section unhelpful for you?
Base URL
Production:
https://api.styngr.com
Staging:
https://stg.api.styngr.com
What made this section unhelpful for you?
roblox-campaign-controller
NFTs
Styngr offers an option to purchase an NFT inside of your application. NFTs are usually minted as a short audio snippet from our available pool of tracks. By purchasing an NFT, user will be able to use the NFT inside of your application, by playing an linked audio snippet. They also have an option to claim the NFT, which would transfer the ownership to their Ripple Ledger account. Styngr can at any time burn the NFT, if such need arises from legal perspective, upon request from record labels.
Xumm
Xumm platfrom is a non-custodial wallet that offers users to create/manage their Ripple Ledger accounts. Users can authenticate their wallets in our system through Xumm, which allows them to claim the already purchased NFTs to their Ripple Ledger account.
Radio Subscriptions - v2
Radio subscriptions allow user to listen to your application's playlist, without Ads. At the moment, user can choose between following subscription types: Monthly, Stream-count based, or Playback-time based. Monthly subscriptions, as their name suggests, allow users to have an unlimited radio listening experience for thirty days after their subscription purchase. Monthly subscriptions can be renewed at any point in time, while they are in active or pending payment state. Monthly subscriptions support multi-tier logic where playlists are divided into several tiers where each tier contains a specific combination of playlists which user is allowed to listen if he has a relevant subscription. Stream-count subscriptions offer a limited number of tracks which users can listen to. Every single request that returns a random track is counted towards this quota. Once the quota is spent, users will have to purchase a new subscription, or they will be back on Ad-funded listening experience if it's available in your application. Playback-time based subscriptions offer a limited number of minutes to which users can listen to. Once the quota is spent, users will have to purchase a new subscription, or they will be back on Ad-funded listening experience.