Get Stynglists

Sections

Theme switcher

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.

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://api.styngr.com

Staging:

https://stg.api.styngr.com

Language Box

Was this section helpful?

What made this section unhelpful for you?

Authentication

Was this section helpful?

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.

Was this section helpful?

What made this section unhelpful for you?

Get Stynglists

Get all Stynglists assigned to an app.

Header Parameters

Authorizationstring

Query Parameters

sizeinteger (int32)Required

Number of Stynglists in response.

pageinteger (int32)Required

Index of page with Stynglist information.

sortstring

Optional sort parameter.

Enum values:
POPULARLAST_ADDEDSHORTEST_FIRST
namestring

Optional keyword that Stynglist should contain.

genresarray

Optional array of genre IDs.

Allow unique items
true
useRedirectUrlboolean

Boolean flag that indicates if Styng image URLs should use redirect URLs pointing to their asset.

Response

200
Object
Page response with Stynglist information.

Response Attributes

itemsarray Required

Show child attributes

itemsCountinteger (int32)Required

Total number of Stynglists for an app that satisfy provided criteria.

pagesCountinteger (int32)Required

Total number of pages for provided size and filters.

401
Object
Access token is not present or expired.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
403
Object
Access is forbidden.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
404
Object
Application user not found.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/api/v1/sdk/stynglists?size=&page=&sort=POPULAR&name=&genres=&useRedirectUrl=

Select
1 2 curl --location 'https://api.styngr.com/api/v1/sdk/stynglists?size=&page=&sort=POPULAR' \ --header 'Authorization: Bearer {token}'

Response

Page response with Stynglist information.
Was this section helpful?

What made this section unhelpful for you?

Get Stynglist filters

Get all filter values for genres and sorting options that can be used to search for Stynglists.

Header Parameters

Authorizationstring

Query Parameters

allboolean

Indicates if all genres should returned or only genres that are used in Stynglists. Defaults to false (only used genres will be returned).

Default value
false

Response

200
Object
List of genres and sort options.

Response Attributes

defaultSortTypestring Required
Enum values:
POPULARLAST_ADDEDSHORTEST_FIRST
genresarray Required

List of Genre objects with their names and IDs.

Show child attributes

sortTypesarray Required

List of possible sort options for Stynglists.

Show child attributes

401
Object
Access token is not present or expired.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
403
Object
Access is forbidden.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/api/v1/sdk/stynglists/filters?all=false

Select
1 2 curl --location 'https://api.styngr.com/api/v1/sdk/stynglists/filters?all=false' \ --header 'Authorization: Bearer {token}'

Response

List of genres and sort options.
Was this section helpful?

What made this section unhelpful for you?

Get Stynglist by ID

Get full Stynglist information.

Header Parameters

Authorizationstring

Query Parameters

useRedirectUrlboolean

Boolean flag that indicates if Styng image URLs should use redirect URLs pointing to their asset.

Path Parameters

idstring (uuid)Required

Stynglist UUID.

Response

200
Object
Information about Stynglist

Response Attributes

currencyobject Required

Show child attributes

genresarray Required

Show child attributes

idstring (uuid)Required
namestring Required
pricenumber Required
sourceTypestring Required
Enum values:
LSRROYALTY_FREE
statusstring Required
Enum values:
AVAILABLEPURCHASEDUNAVAILABLE
styngsarray Required

Show child attributes

401
Object
Access token is not present or expired.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
403
Object
Access is forbidden.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
404
Object
Application user or Stynglist not found

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

GET

/api/v1/sdk/stynglists/{id}?useRedirectUrl=

Select
1 2 curl --location --globoff 'https://api.styngr.com/api/v1/sdk/stynglists/{id}' \ --header 'Authorization: Bearer {token}'

Response

Information about Stynglist
Was this section helpful?

What made this section unhelpful for you?

Buy Stynglist

Place a transaction for user that buys a Stynglist.

Header Parameters

Authorizationstring

Path Parameters

stynglistIdstring (uuid)Required

Stynglist UUID that user is buying.

Response

200
Object
Information about created transaction with External Payment System URL.

Response Attributes

paymentUrlstring
pricenumber Required
productNamestring Required
transactionIdstring (uuid)Required
userIdstring Required
401
Object
Access token is not present or expired.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
403
Object
Access is forbidden.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
404
Object
Application user not found. Stynglist not found.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/stynglists/{stynglistId}/buy

Select
1 2 curl --location --globoff --request POST 'https://api.styngr.com/api/v1/sdk/stynglists/{stynglistId}/buy' \ --header 'Authorization: Bearer {token}'

Response

Information about created transaction with External Payment System URL.
Was this section helpful?

What made this section unhelpful for you?

Get all stynglists for application.

Get all synglists assigned to an application with provided application ID.

Header Parameters

x-api-tokenstring Required

Path Parameters

appIdstring (uuid)Required

Response

200
Object
List of stynglists.

Response Attributes

appIdstring (uuid)Required
stynglistsarray Required

Show child attributes

404
Object
Application is not found or the API key does not match for selected application.

Response Attributes

appIdstring (uuid)Required
stynglistsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/api/v2/sdk/stynglists/apps/{appId}

Select
1 2 curl --location --globoff 'https://api.styngr.com/api/v2/sdk/stynglists/apps/{appId}' \ --header 'x-api-token;'

Response

List of stynglists.
Was this section helpful?

What made this section unhelpful for you?

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.

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.

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://api.styngr.com

Staging:

https://stg.api.styngr.com

Language Box

Was this section helpful?

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.