Get current user Nfts

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.

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.

Was this section helpful?

What made this section unhelpful for you?

Get Nfts

Get information about published Nfts for application with ID provided via User JWT.

Header Parameters

Authorizationstring

Query Parameters

sizeinteger (int32)Required

Number of NFTs in response.

pageinteger (int32)Required

Index of page with NFT information.

Response

200
Object
Paginated response with information about Nfts in Application.

Response Attributes

itemsarray Required

Show child attributes

itemsCountinteger (int32)Required
pagesCountinteger (int32)Required
400
Object
Requested page number must be bigger than 0

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
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/nfts?size=&page=

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

Response

Paginated response with information about Nfts in Application.
Was this section helpful?

What made this section unhelpful for you?

Get current user Nfts

Get all distinct user's Nfts.

Header Parameters

Authorizationstring

Response

200
Object
Users Nfts

Response Attributes

nftResponsesarray 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 not found.

Response Attributes

nftResponsesarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/api/v1/sdk/nfts/my

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

Response

Users Nfts
Was this section helpful?

What made this section unhelpful for you?

Confirm NFT purchase

Confirm that payment for NFT purchase is successfully completed. After confirmation, the user will have access to their NFT. If transaction is not confirmed on time, error message will be returned and user will have to attempt to buy NFT again. In case when transaction is not confirmed on time, user's payment should be rolled back.

Header Parameters

x-api-tokenstring Required

Application API Key.

Body Parameters

applicationIdstring (uuid)Required
transactionIdstring (uuid)Required

Response

204
Object
Response does not contain a body.
403
Object
Transaction was not confirmed on time. Payment rollback should be performed for user.
404
Object
Transaction with provided ID does not exist.
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/nfts/payment/confirm

Select
1 2 3 4 5 6 curl --location 'https://api.styngr.com/api/v1/sdk/nfts/payment/confirm' \ --header 'x-api-token;' \ --data '{ "applicationId": "", "transactionId": "" }'

Response

Response does not contain a body.
Was this section helpful?

What made this section unhelpful for you?

Get NFT Collections preview availability

Get Information about preview availability for NFT Collections

Header Parameters

Authorizationstring

Query Parameters

nftCollectionIdsarray

NFT Collections IDs.

Allow unique items
true

Response

200
Object
NFT Collections IDs mapped by Boolean showing if NFT Collections can be previewed at the moment
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
Collections with provided IDs not found
Was this section helpful?

What made this section unhelpful for you?

GET

/api/v1/sdk/nfts/previewAvailable?nftCollectionIds=

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

Response

NFT Collections IDs mapped by Boolean showing if NFT Collections can be previewed at the moment
Was this section helpful?

What made this section unhelpful for you?

Purchase NFT

Purchase an NFT from provided NFTCollection ID. The API will attempt to find an available NFT was not yet purchased by any other user. If no such NFT can be found, an error will be returned instead.

Header Parameters

Authorizationstring

Path Parameters

nftCollectionIdstring (uuid)Required

Response

200
Object
Response contains information about created transaction.

Response Attributes

externalUserIdstring Required
nftCollectionIdstring (uuid)Required
nftCollectionNamestring Required
nftLedgerIdstring Required
transactionIdstring (uuid)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
NFTCollection has no available NFTs for purchase.

Response Attributes

externalUserIdstring Required
nftCollectionIdstring (uuid)Required
nftCollectionNamestring Required
nftLedgerIdstring Required
transactionIdstring (uuid)Required
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/nfts/{nftCollectionId}/buy

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

Response

Response contains information about created transaction.
Was this section helpful?

What made this section unhelpful for you?

Preview NFT

Create a NFT preview URL. User who owns NFTs in collection can create

Header Parameters

Authorizationstring

Path Parameters

nftCollectionIdstring (uuid)Required

NFT Collection UUID.

Response

200
Object
NFT Preview URL.
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
NFT Collection not found

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/nfts/{nftCollectionId}/preview

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

Response

NFT Preview URL.
Was this section helpful?

What made this section unhelpful for you?

Bind Nft

Bind provided Nft to App Event for given user.

Header Parameters

Authorizationstring

Path Parameters

nftIdstring (uuid)Required

Nft UUID.

Body Parameters

eventIdstring (uuid)Required

UUID of App Event to which Styng or Nft should be bound.

Response

200
Object
Information about successfully created binding.

Response Attributes

appEventIdstring (uuid)Required
externalUserIdstring Required
nftIdstring (uuid)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
Indicates that user or app event does not exist. It can also indicate that the user does not own a Nft with the provided ID.

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/nfts/{nftId}/bind

Select
1 2 3 4 5 curl --location --globoff 'https://api.styngr.com/api/v1/sdk/nfts/{nftId}/bind' \ --header 'Authorization: Bearer {token}' \ --data '{ "eventId": "be84ffeb-c1fb-439a-8b73-4d45710af508" }'

Response

Information about successfully created binding.
Was this section helpful?

What made this section unhelpful for you?

Claim NFT

Claim an purchased NFT. The API will attempt to find specified NFT and claim it. If user doesn't own such NFT, NFT is already claimed or in a process of claiming, an error will be returned instead.If user doesn't have XRPL wallet and valid XUMM token he will receive error as well.

Header Parameters

Authorizationstring

Path Parameters

nftIdstring (uuid)Required

Response

200
Object
Response contains information about NFT with updated status.

Response Attributes

artiststring Required
durationstring (duration)Required
genrestring Required
idstring (uuid)Required
imageUrlstring Required
labelstring Required
nftNamestring Required
statusstring Required
styngIdstring (uuid)Required
trackTitlestring 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
User XRPL account is not active.

Response Attributes

artiststring Required
durationstring (duration)Required
genrestring Required
idstring (uuid)Required
imageUrlstring Required
labelstring Required
nftNamestring Required
statusstring Required
styngIdstring (uuid)Required
trackTitlestring Required
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/nfts/{nftId}/claim

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

Response

Response contains information about NFT with updated status.
Was this section helpful?

What made this section unhelpful for you?

Play NFT

Create a NFT play URL. User that owns NFT from requested NFT collection can create as many preview links as they want while other users can create only one URL.

Header Parameters

Authorizationstring

Path Parameters

nftIdstring (uuid)Required

NFT UUID.

Response

200
Object
NFT Play URL.
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
NFT not found for user

Response Attributes

errorCodeinteger (int32)Required
errorMessagestring
Was this section helpful?

What made this section unhelpful for you?

POST

/api/v1/sdk/nfts/{nftId}/play

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

Response

NFT Play URL.
Was this section helpful?

What made this section unhelpful for you?

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.