soundcloud
Module soundcloud
API
Definitions
ballerinax/soundcloud Ballerina library
Overview
SoundCloud is an online audio platform where artists and listeners share, discover and discuss music and other audio.
The SoundCloud connector lets Ballerina applications call the SoundCloud Public API (version 1.0.0) to search and manage tracks, playlists and users, read and post comments, and like, repost and follow content on behalf of an authenticated user.
Key features
- Search tracks, playlists and users, and read their details
- Upload tracks and create or update playlists
- Read and post comments on tracks
- Like, repost and follow tracks, playlists and users
- Authenticate with OAuth 2.1 (client credentials, authorization code) or an access token
Setup guide
To use the SoundCloud connector, you need an access token for the SoundCloud API.
-
Sign in to SoundCloud and register an application on the SoundCloud for Developers page.
-
Copy the Client ID and Client Secret of the application.
-
Set the redirect URL of the application if you plan to use the authorization code flow.
-
Keep the credentials safe and supply them to the connector through your
Config.tomlfile. The connector requests tokens fromhttps://secure.soundcloud.com/oauth/tokenby default.
Quickstart
To use the soundcloud connector in your Ballerina application, update the .bal file as follows:
-
Import the
soundcloudmodule.import ballerinax/soundcloud; -
Add the application credentials to the
Config.tomlfile.clientId = "<CLIENT_ID>" clientSecret = "<CLIENT_SECRET>" -
Create a
soundcloud:Clientwith the client credentials grant.configurable string clientId = ?; configurable string clientSecret = ?; soundcloud:Client soundcloudClient = check new ({auth: {clientId, clientSecret}}); -
Search for tracks.
public function main() returns error? { soundcloud:TracksResult _ = check soundcloudClient->searchTracks(q = "synthwave", linkedPartitioning = true); }
Examples
The SoundCloud connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Genre playlist builder - Search tracks of a genre, collect them into a new playlist and read the playlist back.
- Track engagement workflow - Review a track's likes and comments, then like and comment on it.
Clients
soundcloud: Client
Provides access to SoundCloud users, tracks, playlists, comments, likes, reposts and followings, so applications can browse, upload and manage audio content on behalf of authenticated users.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.soundcloud.com" - URL of the target service
getMe
Returns the authenticated user’s information.
listMyFeed
function listMyFeed(map<string|string[]> headers, *ListMyFeedQueries queries) returns Activities|errorReturns the authenticated user's feed.
Parameters
- queries *ListMyFeedQueries - Queries to be sent with the request
Return Type
- Activities|error - Success
listMyFeedTracks
function listMyFeedTracks(map<string|string[]> headers, *ListMyFeedTracksQueries queries) returns Activities|errorReturns the authenticated user's recent track related feed.
Parameters
- queries *ListMyFeedTracksQueries - Queries to be sent with the request
Return Type
- Activities|error - Success
listMyRecentlyPlayedTracks
function listMyRecentlyPlayedTracks(map<string|string[]> headers, *ListMyRecentlyPlayedTracksQueries queries) returns TracksResult|errorReturns the authenticated user's last 25 recently played tracks.
Parameters
- queries *ListMyRecentlyPlayedTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listMyLikedTracks
function listMyLikedTracks(map<string|string[]> headers, *ListMyLikedTracksQueries queries) returns TracksResult|errorReturns a list of favorited or liked tracks of the authenticated user.
Parameters
- queries *ListMyLikedTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listMyLikedPlaylists
function listMyLikedPlaylists(map<string|string[]> headers, *ListMyLikedPlaylistsQueries queries) returns PlaylistsResult|errorReturns a list of favorited or liked playlists of the authenticated user.
Parameters
- queries *ListMyLikedPlaylistsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
listMyLikedSystemPlaylists
function listMyLikedSystemPlaylists(map<string|string[]> headers, *ListMyLikedSystemPlaylistsQueries queries) returns SystemPlaylistsResult|errorReturns a list of liked system playlists (stations) of the authenticated user.
Parameters
- queries *ListMyLikedSystemPlaylistsQueries - Queries to be sent with the request
Return Type
- SystemPlaylistsResult|error - Success
listMyFollowings
function listMyFollowings(map<string|string[]> headers, *ListMyFollowingsQueries queries) returns Users|errorReturns a list of users who are followed by the authenticated user.
Parameters
- queries *ListMyFollowingsQueries - Queries to be sent with the request
listMyFollowingsTracks
function listMyFollowingsTracks(map<string|string[]> headers, *ListMyFollowingsTracksQueries queries) returns TracksList|errorReturns a list of recent tracks from users followed by the authenticated user.
Parameters
- queries *ListMyFollowingsTracksQueries - Queries to be sent with the request
Return Type
- TracksList|error - Success
followUser
Follows a user.
Parameters
- userUrn string - SoundCloud User id
unfollowUser
Deletes a user who is followed by the authenticated user.
Parameters
- userUrn string - SoundCloud User id
Return Type
- json|error - The user was unfollowed
listMyFollowers
function listMyFollowers(map<string|string[]> headers, *ListMyFollowersQueries queries) returns Users|errorReturns a list of users who are following the authenticated user.
Parameters
- queries *ListMyFollowersQueries - Queries to be sent with the request
listMyPlaylists
function listMyPlaylists(map<string|string[]> headers, *ListMyPlaylistsQueries queries) returns PlaylistsResult|errorReturns user’s playlists (sets).
Parameters
- queries *ListMyPlaylistsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
listMyTracks
function listMyTracks(map<string|string[]> headers, *ListMyTracksQueries queries) returns TracksResult|errorReturns a list of the authenticated user's tracks.
Parameters
- queries *ListMyTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listMyTrackReposts
function listMyTrackReposts(map<string|string[]> headers, *ListMyTrackRepostsQueries queries) returns TracksResult|errorReturns a list of track reposts of the authenticated user.
Parameters
- queries *ListMyTrackRepostsQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listMyPlaylistReposts
function listMyPlaylistReposts(map<string|string[]> headers, *ListMyPlaylistRepostsQueries queries) returns PlaylistsResult|errorReturns a list of playlist reposts of the authenticated user.
Parameters
- queries *ListMyPlaylistRepostsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
searchTracks
function searchTracks(map<string|string[]> headers, *SearchTracksQueries queries) returns TracksResult|errorPerforms a track search based on a query
Parameters
- queries *SearchTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
uploadTrack
function uploadTrack(UploadTrackFormRequest payload, map<string|string[]> headers) returns Track|errorUploads a new track.
Parameters
- payload UploadTrackFormRequest - Track metadata and the audio file to upload
searchPlaylists
function searchPlaylists(map<string|string[]> headers, *SearchPlaylistsQueries queries) returns PlaylistsResult|errorPerforms a playlist search based on a query
Parameters
- queries *SearchPlaylistsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
createPlaylist
function createPlaylist(CreateUpdatePlaylistRequest payload, map<string|string[]> headers) returns Playlist|errorCreates a playlist.
Parameters
- payload CreateUpdatePlaylistRequest - Create Playlist request
searchUsers
Performs a user search based on a query
Parameters
- queries *SearchUsersQueries - Queries to be sent with the request
getPlaylist
function getPlaylist(string playlistUrn, map<string|string[]> headers, *GetPlaylistQueries queries) returns Playlist|errorReturns a playlist.
Parameters
- playlistUrn string - User playlist URN or system playlist (station) URN.
Examples:
- User playlist:
soundcloud:playlists:1212781357 - System playlist (station):
soundcloud:system-playlists:track-stations:2287580618
- User playlist:
- queries *GetPlaylistQueries - Queries to be sent with the request
updatePlaylist
function updatePlaylist(string playlistUrn, CreateUpdatePlaylistRequest payload, map<string|string[]> headers) returns Playlist|errorUpdates a playlist.
Parameters
- playlistUrn string - SoundCloud playlist id
- payload CreateUpdatePlaylistRequest - Playlist payload
deletePlaylist
Deletes a playlist.
Parameters
- playlistUrn string - SoundCloud playlist id
Return Type
- error? - Success
listPlaylistTracks
function listPlaylistTracks(string playlistUrn, map<string|string[]> headers, *ListPlaylistTracksQueries queries) returns TracksResult|errorReturns tracks under a playlist.
Parameters
- playlistUrn string - User playlist URN or system playlist (station) URN.
Examples:
- User playlist:
soundcloud:playlists:1212781357 - System playlist (station):
soundcloud:system-playlists:track-stations:2287580618
- User playlist:
- queries *ListPlaylistTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listPlaylistReposters
function listPlaylistReposters(string playlistUrn, map<string|string[]> headers, *ListPlaylistRepostersQueries queries) returns Users|errorReturns a collection of playlist's reposters.
Parameters
- playlistUrn string - User playlist URN or system playlist (station) URN.
Examples:
- User playlist:
soundcloud:playlists:1212781357 - System playlist (station):
soundcloud:system-playlists:track-stations:2287580618
- User playlist:
- queries *ListPlaylistRepostersQueries - Queries to be sent with the request
getTrack
function getTrack(string trackUrn, map<string|string[]> headers, *GetTrackQueries queries) returns Track|errorReturns a track.
Parameters
- trackUrn string - SoundCloud Track urn
- queries *GetTrackQueries - Queries to be sent with the request
updateTrack
function updateTrack(string trackUrn, TrackMetadataRequest payload, map<string|string[]> headers) returns Track|errorUpdates a track's information.
deleteTrack
Deletes a track.
Parameters
- trackUrn string - SoundCloud Track urn
Return Type
- error? - Success
updateTrackStorefront
function updateTrackStorefront(string trackUrn, StorefrontUpdateRequest payload, map<string|string[]> headers) returns Storefront|errorCreates or updates the storefront (Artist Storefront) of a track.
Parameters
- trackUrn string - SoundCloud Track urn
- payload StorefrontUpdateRequest - Storefront payload
Return Type
- Storefront|error - The updated track storefront
getTrackPreview
function getTrackPreview(string trackUrn, map<string|string[]> headers, *GetTrackPreviewQueries queries) returns Response|errorStarts playback of a preview of the track
Parameters
- trackUrn string - SoundCloud Track urn
- queries *GetTrackPreviewQueries - Queries to be sent with the request
getTrackStreams
function getTrackStreams(string trackUrn, map<string|string[]> headers, *GetTrackStreamsQueries queries) returns Streams|errorReturns a track's streamable URLs (needs to keep using authentication)
Parameters
- trackUrn string - SoundCloud Track urn
- queries *GetTrackStreamsQueries - Queries to be sent with the request
listTrackComments
function listTrackComments(string trackUrn, map<string|string[]> headers, *ListTrackCommentsQueries queries) returns Comments|errorReturns the comments posted on the track(track_urn).
Parameters
- trackUrn string - SoundCloud Track urn
- queries *ListTrackCommentsQueries - Queries to be sent with the request
createTrackComment
function createTrackComment(string trackUrn, CreateTrackCommentRequest payload, map<string|string[]> headers) returns Comment|errorCreates a comment on a track.
Parameters
- trackUrn string - SoundCloud Track urn
- payload CreateTrackCommentRequest - Body of a comment
listTrackFavoriters
function listTrackFavoriters(string trackUrn, map<string|string[]> headers, *ListTrackFavoritersQueries queries) returns Users|errorReturns a list of users who have favorited or liked the track.
Parameters
- trackUrn string - SoundCloud Track urn
- queries *ListTrackFavoritersQueries - Queries to be sent with the request
listTrackReposters
function listTrackReposters(string trackUrn, map<string|string[]> headers, *ListTrackRepostersQueries queries) returns Users|errorReturns a collection of track's reposters.
Parameters
- trackUrn string - SoundCloud Track urn
- queries *ListTrackRepostersQueries - Queries to be sent with the request
listRelatedTracks
function listRelatedTracks(string trackUrn, map<string|string[]> headers, *ListRelatedTracksQueries queries) returns TracksResult|errorReturns all related tracks of track on SoundCloud.
Parameters
- trackUrn string - SoundCloud Track urn
- queries *ListRelatedTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
getSystemPlaylist
function getSystemPlaylist(string id, map<string|string[]> headers, *GetSystemPlaylistQueries queries) returns SystemPlaylist|errorReturns a system playlist.
Parameters
- id string - System playlist URN or identifier. Accepts a full URN (e.g.
soundcloud:system-playlists:track-stations:2287580618) or the identifier portion (e.g.track-stations:2287580618)
- queries *GetSystemPlaylistQueries - Queries to be sent with the request
Return Type
- SystemPlaylist|error - Success
resolveUrl
function resolveUrl(map<string|string[]> headers, *ResolveUrlQueries queries) returns Response|errorResolves soundcloud.com and on.soundcloud.com URLs to Resource URLs to use with the API.
Parameters
- queries *ResolveUrlQueries - Queries to be sent with the request
getUser
Returns a user.
Parameters
- userUrn string - SoundCloud User id
listRelatedUsers
function listRelatedUsers(string userUrn, map<string|string[]> headers, *ListRelatedUsersQueries queries) returns Users|errorReturns related artist recommendations for a user on SoundCloud.
Parameters
- userUrn string - SoundCloud User id
- queries *ListRelatedUsersQueries - Queries to be sent with the request
listUserFollowers
function listUserFollowers(string userUrn, map<string|string[]> headers, *ListUserFollowersQueries queries) returns Users|errorReturns a list of user’s followers.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserFollowersQueries - Queries to be sent with the request
listUserFollowings
function listUserFollowings(string userUrn, map<string|string[]> headers, *ListUserFollowingsQueries queries) returns Users|errorReturns a list of user’s followings.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserFollowingsQueries - Queries to be sent with the request
listUserPlaylists
function listUserPlaylists(string userUrn, map<string|string[]> headers, *ListUserPlaylistsQueries queries) returns PlaylistsResult|errorReturns a list of user's playlists.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserPlaylistsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
listUserTracks
function listUserTracks(string userUrn, map<string|string[]> headers, *ListUserTracksQueries queries) returns TracksResult|errorReturns a list of a given user's tracks.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listUserWebProfiles
function listUserWebProfiles(string userUrn, map<string|string[]> headers, *ListUserWebProfilesQueries queries) returns WebProfiles|errorReturns list of user's links added to their profile (website, facebook, instagram).
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserWebProfilesQueries - Queries to be sent with the request
Return Type
- WebProfiles|error - Success
listUserLikedTracks
function listUserLikedTracks(string userUrn, map<string|string[]> headers, *ListUserLikedTracksQueries queries) returns TracksResult|errorReturns a list of user's liked tracks.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserLikedTracksQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listUserLikedPlaylists
function listUserLikedPlaylists(string userUrn, map<string|string[]> headers, *ListUserLikedPlaylistsQueries queries) returns PlaylistsResult|errorReturns a list of user's liked playlists.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserLikedPlaylistsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
listUserLikedSystemPlaylists
function listUserLikedSystemPlaylists(string userUrn, map<string|string[]> headers, *ListUserLikedSystemPlaylistsQueries queries) returns SystemPlaylistsResult|errorReturns a list of user's liked system playlists (stations).
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserLikedSystemPlaylistsQueries - Queries to be sent with the request
Return Type
- SystemPlaylistsResult|error - Success
listUserTrackReposts
function listUserTrackReposts(string userUrn, map<string|string[]> headers, *ListUserTrackRepostsQueries queries) returns TracksResult|errorReturns a list of user's track reposts.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserTrackRepostsQueries - Queries to be sent with the request
Return Type
- TracksResult|error - Success
listUserPlaylistReposts
function listUserPlaylistReposts(string userUrn, map<string|string[]> headers, *ListUserPlaylistRepostsQueries queries) returns PlaylistsResult|errorReturns a list of user's playlist reposts.
Parameters
- userUrn string - SoundCloud User id
- queries *ListUserPlaylistRepostsQueries - Queries to be sent with the request
Return Type
- PlaylistsResult|error - Success
likeTrack
Likes a track.
Parameters
- trackUrn string - SoundCloud Track id
Return Type
- json|error - Success
unlikeTrack
Unlikes a track.
Parameters
- trackUrn string - SoundCloud Track id
Return Type
- json|error - Success
likePlaylist
Likes a playlist or system playlist (station).
Parameters
- playlistUrn string - User playlist URN or system playlist (station) URN.
Examples:
- User playlist:
soundcloud:playlists:1212781357 - System playlist (station):
soundcloud:system-playlists:track-stations:2287580618
- User playlist:
Return Type
- json|error - Success
unlikePlaylist
Unlikes a playlist or system playlist (station).
Parameters
- playlistUrn string - User playlist URN or system playlist (station) URN.
Examples:
- User playlist:
soundcloud:playlists:1212781357 - System playlist (station):
soundcloud:system-playlists:track-stations:2287580618
- User playlist:
Return Type
- json|error - Success
repostTrack
Reposts a track as the authenticated user
Parameters
- trackUrn string - SoundCloud Track id
Return Type
- error? - Created
repostPlaylist
Reposts a playlist as the authenticated user
Parameters
- playlistUrn string - SoundCloud playlist id
Return Type
- error? - Created
removePlaylistRepost
Removes a repost on a playlist as the authenticated user
Parameters
- playlistUrn string - SoundCloud playlist id
Return Type
- error? - Success
disconnectApp
Revokes OAuth access for the calling application.
Return Type
- error? - Tokens invalidated successfully
signOut
Invalidates the session associated with the current token.
Return Type
- error? - Success
Records
soundcloud: Activities
User's activities
Fields
- futureHref? string - URL to fetch activities newer than this page
- collection? ActivitiesCollection[] - List of activities
- nextHref? string - URL of the next page of activities
soundcloud: ActivitiesCollection
Fields
- createdAt string - Created timestamp
- 'type string - Type of activity (e.g.
track,track:repost,playlist,playlist:repost). Fortrack:repostandplaylist:repost, the API also returns a top-level string fieldreposterwith the URN of the user who reposted
soundcloud: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - The string "OAuth" followed by the user’s token: OAuth ACCESS_TOKEN. Obtained in oAuth2.1 flow
soundcloud: bpm
Fields
- 'from? int - Return tracks with at least this bpm value
- to? int - Return tracks with at most this bpm value
soundcloud: Comment
User's Comment
Fields
- urn? string - Identifier
- kind? string - Kind (comment)
- trackUrn? string - Track's identifier
- createdAt? string - Created timestamp
- body? string - Comment body
- uri? string - Comment's URL
- user? CommentUser - SoundCloud User object
- userUrn? string - User's identifier
- timestamp? string - Timestamp
soundcloud: Comments
Fields
- collection? Comment[] -
- nextHref? string? -
soundcloud: CommentUser
SoundCloud User object
Fields
- urn? string - unique identifier
- avatarUrl? string - URL to a JPEG image
- kind? string - kind of resource
- followersCount? int - number of followers
- repostsCount? int - number of reposts from user
- permalink? string - permalink of the resource
- permalinkUrl? string - URL to the SoundCloud.com page
- lastModified? string - last modified timestamp
- uri? string - API resource URL
- followingsCount? int - number of followed users
- username? string - username
soundcloud: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig|OAuth2RefreshTokenGrantConfig|ApiKeysConfig - Provides Auth configurations needed when communicating with a remote HTTP endpoint.
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
soundcloud: created_at
Fields
- 'from? string - (yyyy-mm-dd hh:mm:ss) return tracks created at this date or later
- to? string - (yyyy-mm-dd hh:mm:ss) return tracks created at this date or earlier
soundcloud: CreateTrackCommentRequest
Fields
- comment? NewTrackComment -
soundcloud: CreateUpdatePlaylistRequest
Fields
- playlist? CreateUpdatePlaylistRequestPlaylist -
soundcloud: CreateUpdatePlaylistRequestPlaylist
Fields
- release? string - Playlist's release
- purchaseUrl? string - Purchase URL
- setType? "album"|"playlist" - Playlist or album type
- description? string - Description of the playlist
- title? string - Title of the playlist
- sharing? "public"|"private" - public or private
- tracks? CreateUpdatePlaylistRequestPlaylistTracks[] - List of tracks to add to playlist
- license? string - License number
- artworkData? record { fileContent byte[], fileName string } -
- purchaseTitle? string - Purchase title
- ean? string - The European Article Number
- releaseDate? string - Release date
- tagList? string - A comma-separated list of tags
- genre? string - Playlist's genre
- permalink? string - Playlist's permalink
- permalinkUrl? string - Full permalink URL
- labelName? string - Label name
soundcloud: CreateUpdatePlaylistRequestPlaylistTracks
Fields
- urn string - SoundCloud track urn
soundcloud: duration
Fields
- 'from? int - Return tracks with at least this duration value
- to? int - Return tracks with at most this duration value
soundcloud: GetPlaylistQueries
Represents the Queries record for the operation: getPlaylist
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- showTracks? boolean - A boolean flag to request a playlist with or without tracks. Default is
true
- secretToken? string - A secret token to fetch private playlists/tracks
soundcloud: GetSystemPlaylistQueries
Represents the Queries record for the operation: getSystemPlaylist
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
soundcloud: GetTrackPreviewQueries
Represents the Queries record for the operation: getTrackPreview
Fields
- secretToken? string - A secret token to fetch private playlists/tracks
soundcloud: GetTrackQueries
Represents the Queries record for the operation: getTrack
Fields
- secretToken? string - A secret token to fetch private playlists/tracks
soundcloud: GetTrackStreamsQueries
Represents the Queries record for the operation: getTrackStreams
Fields
- secretToken? string - A secret token to fetch private playlists/tracks
soundcloud: ListMyFeedQueries
Represents the Queries record for the operation: listMyFeed
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListMyFeedTracksQueries
Represents the Queries record for the operation: listMyFeedTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListMyFollowersQueries
Represents the Queries record for the operation: listMyFollowers
Fields
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListMyFollowingsQueries
Represents the Queries record for the operation: listMyFollowings
Fields
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListMyFollowingsTracksQueries
Represents the Queries record for the operation: listMyFollowingsTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListMyLikedPlaylistsQueries
Represents the Queries record for the operation: listMyLikedPlaylists
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListMyLikedSystemPlaylistsQueries
Represents the Queries record for the operation: listMyLikedSystemPlaylists
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListMyLikedTracksQueries
Represents the Queries record for the operation: listMyLikedTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListMyPlaylistRepostsQueries
Represents the Queries record for the operation: listMyPlaylistReposts
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListMyPlaylistsQueries
Represents the Queries record for the operation: listMyPlaylists
Fields
- 'limit int(default 50) - Number of results to return in the collection
- showTracks? boolean - A boolean flag to request a playlist with or without tracks. Default is
true
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListMyRecentlyPlayedTracksQueries
Represents the Queries record for the operation: listMyRecentlyPlayedTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
soundcloud: ListMyTrackRepostsQueries
Represents the Queries record for the operation: listMyTrackReposts
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListMyTracksQueries
Represents the Queries record for the operation: listMyTracks
Fields
- 'limit int(default 50) - Number of results to return in the collection
- sort "asc"|"desc" (default "desc") - Sort order of tracks by upload date.
descreturns newest tracks first;ascreturns oldest first. Also acceptsdirectionororderas aliases
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListPlaylistRepostersQueries
Represents the Queries record for the operation: listPlaylistReposters
Fields
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListPlaylistTracksQueries
Represents the Queries record for the operation: listPlaylistTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- secretToken? string - A secret token to fetch private playlists/tracks
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListRelatedTracksQueries
Represents the Queries record for the operation: listRelatedTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListRelatedUsersQueries
Represents the Queries record for the operation: listRelatedUsers
Fields
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListTrackCommentsQueries
Represents the Queries record for the operation: listTrackComments
Fields
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListTrackFavoritersQueries
Represents the Queries record for the operation: listTrackFavoriters
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListTrackRepostersQueries
Represents the Queries record for the operation: listTrackReposters
Fields
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListUserFollowersQueries
Represents the Queries record for the operation: listUserFollowers
Fields
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListUserFollowingsQueries
Represents the Queries record for the operation: listUserFollowings
Fields
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: ListUserLikedPlaylistsQueries
Represents the Queries record for the operation: listUserLikedPlaylists
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserLikedSystemPlaylistsQueries
Represents the Queries record for the operation: listUserLikedSystemPlaylists
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserLikedTracksQueries
Represents the Queries record for the operation: listUserLikedTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserPlaylistRepostsQueries
Represents the Queries record for the operation: listUserPlaylistReposts
Fields
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserPlaylistsQueries
Represents the Queries record for the operation: listUserPlaylists
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
- showTracks? boolean - A boolean flag to request a playlist with or without tracks. Default is
true
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserTrackRepostsQueries
Represents the Queries record for the operation: listUserTrackReposts
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserTracksQueries
Represents the Queries record for the operation: listUserTracks
Fields
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- 'limit int(default 50) - Number of results to return in the collection
- sort "asc"|"desc" (default "desc") - Sort order of tracks by upload date.
descreturns newest tracks first;ascreturns oldest first. Also acceptsdirectionororderas aliases
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: ListUserWebProfilesQueries
Represents the Queries record for the operation: listUserWebProfiles
Fields
- 'limit int(default 50) - Number of results to return in the collection
soundcloud: Me
SoundCloud Me object
Fields
- country? string - country
- subscriptions? Subscription[] - a list subscriptions associated with the user
- city? string - city
- createdAt? string - created at date
- description? string - description
- locale? string? - locale
- trackCount? int - number of public tracks
- discogsName? string - discogs name
- privatePlaylistsCount? int - number of private playlists
- quota? MeQuota - user's upload quota
- primaryEmailConfirmed? boolean - boolean if email is confirmed
- publicFavoritesCount? int - number of favorited public tracks
- privateTracksCount? int - number of private tracks
- repostsCount? int - number of reposts from user
- websiteTitle? string - a custom title for the website
- firstName? string - first name
- lastModified? string - last modified timestamp
- plan? string - subscription plan of the user
- playlistCount? int - number of public playlists
- website? string - a URL to the website
- kind? string - kind of resource
- lastName? string - last name
- followingsCount? int - number of followed users
- uri? string - API resource URL
- urn? string - unique identifier
- likesCount? int - likes count
- uploadSecondsLeft? int? - upload seconds left
- fullName? string - first and last name
- avatarUrl? string - URL to a JPEG image
- followersCount? int - number of followers
- online? boolean - online
- permalink? string - permalink of the resource
- permalinkUrl? string - URL to the SoundCloud.com page
- username? string - username
soundcloud: MeQuota
user's upload quota
Fields
- unlimitedUploadQuota? boolean - unlimited upload quota
- uploadSecondsLeft? int? - upload seconds left
- uploadSecondsUsed? int - upload seconds used
soundcloud: NewTrackComment
Fields
- body string - Comment's content
soundcloud: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://secure.soundcloud.com/oauth/token") - Token URL
soundcloud: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://secure.soundcloud.com/oauth/token") - Refresh URL
soundcloud: Playlist
Soundcloud Playlist Object
Fields
- downloadable? boolean - is downloadable
- release? string - Release
- tracksUri? string? - tracks URI
- createdAt? string - Created timestamp
- description? string - Playlist description
- title? string - Playlist title
- 'type? string - Playlist type
- trackCount? int - Count of tracks
- duration? int - Playlist duration
- artworkUrl? string - URL to a JPEG image
- ean? string - European Article Number
- streamable? boolean - Is streamable
- tagList? string - Tags
- releaseMonth? int - Month of release
- genre? string - Playlist genre
- releaseDay? int - Day of release
- labelName? string - Label name
- lastModified? string - Last modified timestamp
- userUrn? string - User identifier
- kind? string - Type of Soundcloud object (playlist)
- purchaseUrl? string - Purchase URL
- releaseYear? int - Year of release
- playlistType? string - Type of playlist
- label? User? - User who owns the record label of the playlist
- sharing? string - Type of sharing (private/public)
- uri? string - Playlist URI
- tracks? Track[] - List of tracks
- tags? string? - Tags
- urn? string - Playlist identifier
- likesCount? int - Count of playlist likes
- license? string - License
- purchaseTitle? string - Purchase title
- embeddableBy? string - Embeddable by
- permalink? string - Playlist permalink
- permalinkUrl? string - Playlist permalink URL
- user? User? - User who created the playlist
- labelId? int - Label user identifier
soundcloud: Playlists
Fields
- collection? Playlist[] -
- nextHref? string -
soundcloud: ResolveUrlQueries
Represents the Queries record for the operation: resolveUrl
Fields
- url string - SoundCloud URL to resolve. Supports track, playlist, user, and system playlist permalinks (e.g.
https://soundcloud.com/discover/sets/track-stations:2287580618)
soundcloud: SearchPlaylistsQueries
Represents the Queries record for the operation: searchPlaylists
Fields
- q? string - search
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
- showTracks? boolean - A boolean flag to request a playlist with or without tracks. Default is
true
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: SearchTracksQueries
Represents the Queries record for the operation: searchTracks
Fields
- duration? duration - Return tracks within a specified duration range
- q? string - search
- access? ("playable"|"preview"|"blocked")[] - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See
Track#accessschema for more details
- urns? string - A comma separated list of track urns to filter on
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- genres? string - A comma separated list of genres
- 'limit int(default 50) - Number of results to return in the collection
- createdAt? created_at - (yyyy-mm-dd hh:mm:ss) return tracks created within the specified dates
- bpm? bpm - Return tracks with a specified bpm[from], bpm[to]
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
- tags? string - A comma separated list of tags
soundcloud: SearchUsersQueries
Represents the Queries record for the operation: searchUsers
Fields
- q? string - search
- urns? string - A comma separated list of track urns to filter on
- offset int(default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead
- 'limit int(default 50) - Number of results to return in the collection
- linkedPartitioning? boolean - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
soundcloud: Storefront
A track's storefront (Artist Storefront / buy module) shown on the track page
Fields
- imageUrl? string? - Image shown on the storefront module. Read-only; managed on soundcloud.com
- price? string? - Display-only price text shown next to the item type. No payment is processed by SoundCloud
- trackUrn? string - The urn of the track the storefront belongs to
- link? string - External URL the storefront button opens
- description? string? - Description shown on the storefront module
- linkTitle? string? - Label of the storefront button
- title? string - Card title shown on the storefront module
- 'type? "digital"|"vinyl"|"cd"|"cassette"|"apparel"|"sample_pack"|"subscription"|"live_event"|"live_stream"|"other" - The type of item offered
soundcloud: StorefrontUpdateRequest
Creates or updates the storefront (Artist Storefront / buy module) of a track. The request replaces the whole storefront - omitted optional fields are cleared, so always send every value the storefront should keep
Fields
- price? string - Display-only price text shown next to the item type. No payment is processed by SoundCloud. Omit to clear
- link string - External http(s) URL the storefront button opens
- description? string - Description shown on the storefront module. Omit to clear
- linkTitle? string - Label of the storefront button. Omit to clear
- title string - Card title shown on the storefront module
- 'type "digital"|"vinyl"|"cd"|"cassette"|"apparel"|"sample_pack"|"subscription"|"live_event"|"live_stream"|"other" - The type of item offered
soundcloud: Streams
Fields
- hlsAac160Url? string -
- hlsMp3128Url? string -
- previewMp3128Url? string -
soundcloud: Subscription
subscription
Fields
- product? SubscriptionProduct - product
- recurring? boolean - if the subscription is recurring or not
soundcloud: SubscriptionProduct
product
Fields
- name? string - subscription name instance
- id? string - subscription id instance
soundcloud: SystemPlaylist
SoundCloud system playlist object (e.g. track station, artist station)
Fields
- urn? string - System playlist URN
- lastUpdated? string? - Last updated timestamp
- kind? string - Type of object (system-playlist)
- queryUrn? string? - Query URN used to generate the playlist, when available
- description? string - Playlist description
- playlistType? string - Playlist type
- title? string - Playlist title
- permalink? string - System playlist permalink slug
- permalinkUrl? string - Permalink URL on soundcloud.com
- trackingFeatureName? string? - Tracking feature name
- trackCount? int - Number of visible tracks in the playlist
- tracks? Track[] - Visible tracks in the playlist
soundcloud: SystemPlaylists
Fields
- collection? SystemPlaylist[] -
- nextHref? string -
soundcloud: Track
Soundcloud Track object
Fields
- commentCount? int - Number of comments
- downloadable? boolean - Is downloadable
- access? "playable"|"preview"|"blocked"? - Level of access the user (logged in or anonymous) has to the track.
playable- user is allowed to listen to a full track.preview- user is allowed to preview a track, meaning a snippet is availableblocked- user can only see the metadata of a track, no streaming is possible
- release? string - Release
- availableCountryCodes? string - List of country codes where track is available
- createdAt? string - Created timestamp
- description? string - Track description
- title? string - Track title
- duration? int - Track duration in milliseconds
- artworkUrl? string - URL to a JPEG image
- streamable? boolean - Is streamable
- tagList? string - Tags
- releaseMonth? int - Month of release
- genre? string - Genre
- releaseDay? int - Day of release
- downloadUrl? string? - URL to download a track. Omitted or null when track is not downloadable
- metadataArtist? string - Optional artist name, when different from user
- repostsCount? int - Number of reposts
- secretUri? string - Secret URL
- labelName? string - Label user name
- bpm? decimal - Tempo
- commentable? boolean - Is commentable
- favoritingsCount? int - Number of favoritings
- kind? string - Type of object (track)
- revealStats? boolean - Whether play and favorite counts are visible. When false (quiet mode), stats are hidden
- purchaseUrl? string - Purchase URL
- releaseYear? int - Year of release
- keySignature? string - Key signature
- isrc? string - ISRC code
- stationUrn? string? - URN of the track's station system playlist, when available. Uses the
system-playlistscollection (e.g.soundcloud:system-playlists:track-stations:{id}). Omitted or null for non-public tracks and tracks without a station
- sharing? string - Type of sharing (public/private)
- uri? string - Track URI
- downloadCount? int - Number of downloads
- urn? string - Track URN identifier
- license? string - License
- purchaseTitle? string - Purchase title
- embeddableBy? string - Embeddable by
- userFavorite? boolean - Is user's favourite. It is only set when fetching search results or single track, otherwise it is false
- revealComments? boolean - Whether comments are visible. When false (quiet mode), comments are hidden
- waveformUrl? string - Waveform URL
- permalinkUrl? string - Permalink URL
- user? User? - User who uploaded a track
- userPlaybackCount? int - Number of plays by a user
- playbackCount? int - Number of plays
- streamUrl? string - URL to stream (preview only)
soundcloud: TrackDataRequest
Fields
- trackArtist? string - Optional artist name for the track. Returned as metadata_artist in track responses. Do not use track[metadata_artist] on upload
- trackArtworkData? record { fileContent byte[], fileName string } -
- trackAssetData? record { fileContent byte[], fileName string } -
- trackPermalink? string -
- trackRelease? string -
- trackLabelName? string -
- trackStreamable boolean(default true) -
- trackPurchaseUrl? string -
- trackIsrc? string -
- trackEmbeddableBy? "all"|"me"|"none" - who can embed this track "all", "me", or "none"
- trackRevealComments? boolean - When false (quiet mode), comments are hidden
- trackReleaseDate? string - string, formatted as yyyy-mm-dd, representing release date
- trackDescription? string -
- trackCommentable boolean(default true) -
- trackLicense? "no-rights-reserved"|"all-rights-reserved"|"cc-by"|"cc-by-nc"|"cc-by-nd"|"cc-by-sa"|"cc-by-nc-nd"|"cc-by-nc-sa" - Possible values: no-rights-reserved, all-rights-reserved, cc-by, cc-by-nc, cc-by-nd, cc-by-sa, cc-by-nc-nd, cc-by-nc-sa
- trackTitle? string -
- trackGenre? string -
- trackSharing "public"|"private" (default "public") -
- trackTagList? string - The tag_list property contains a list of tags separated by spaces. Multiword tags are quoted in double quotes. We also support machine tags that follow the pattern NAMESPACE:KEY=VALUE. For example: geo:lat=43.555 camel:size=medium “machine:tag=with space” Machine tags are not revealed to the user on the track pages
- trackRevealStats? boolean - When false (quiet mode), play and favorite counts are hidden
- trackDownloadable boolean(default true) -
soundcloud: TrackMetadataRequest
Fields
- track? TrackMetadataRequestTrack -
soundcloud: TrackMetadataRequestTrack
Fields
- downloadable boolean(default true) -
- release? string -
- revealStats? boolean - When false (quiet mode), play and favorite counts are hidden
- purchaseUrl? string -
- description? string -
- isrc? string -
- title? string -
- sharing "public"|"private" (default "public") -
- license? "no-rights-reserved"|"all-rights-reserved"|"cc-by"|"cc-by-nc"|"cc-by-nd"|"cc-by-sa"|"cc-by-nc-nd"|"cc-by-nc-sa" - Possible values: no-rights-reserved, all-rights-reserved, cc-by, cc-by-nc, cc-by-nd, cc-by-sa, cc-by-nc-nd, cc-by-nc-sa
- embeddableBy? "all"|"me"|"none" - who can embed this track "all", "me", or "none"
- releaseDate? string - string, formatted as yyyy-mm-dd, representing release date
- streamable boolean(default true) -
- tagList? string - The tag_list property contains a list of tags separated by spaces. Multiword tags are quoted in double quotes. We also support machine tags that follow the pattern NAMESPACE:KEY=VALUE. For example: geo:lat=43.555 camel:size=medium “machine:tag=with space” Machine tags are not revealed to the user on the track pages
- revealComments? boolean - When false (quiet mode), comments are hidden
- genre? string -
- metadataArtist? string - Optional artist name, when different from user. Use this field in JSON PUT requests (or track[metadata_artist] in multipart PUT requests); use track[artist] in multipart POST uploads
- permalink? string -
- labelName? string -
- commentable boolean(default true) -
soundcloud: Tracks
Fields
- collection? Track[] -
- nextHref? string -
soundcloud: User
SoundCloud User object
Fields
- country? string - country
- subscriptions? Subscription[] - a list subscriptions associated with the user
- city? string - city
- description? string - description
- createdAt? string - profile creation datetime
- trackCount? int - number of public tracks
- discogsName? string - discogs name
- publicFavoritesCount? int - number of favorited public tracks
- repostsCount? int - number of reposts from user
- websiteTitle? string - a custom title for the website
- firstName? string - first name
- lastModified? string - last modified datetime
- plan? string - subscription plan of the user
- playlistCount? int - number of public playlists
- website? string - a URL to the website
- kind? string - kind of resource
- lastName? string - last name
- stationUrn? string? - URN of the user's artist station system playlist, when available. Uses the
system-playlistscollection (e.g.soundcloud:system-playlists:artist-stations:{id}). Omitted or null when the user has no public tracks or no station
- followingsCount? int - number of followed users
- uri? string - API resource URL
- urn? string - unique identifier
- fullName? string - first and last name
- avatarUrl? string - URL to a JPEG image
- followersCount? int - number of followers
- permalink? string - permalink of the resource
- permalinkUrl? string - URL to the SoundCloud.com page
- username? string - username
soundcloud: Users
Fields
- collection? User[] -
- nextHref? string -
soundcloud: WebProfile
Fields
- urn? string - Id
- kind? string - Kind
- 'service? string - Service or platform
- createdAt? string - Timestamp of when the link was added to the profile
- title? string - Link's title
- url? string - URL of the external link
- username? string - Username extracted from the external link
Union types
soundcloud: PlaylistsResult
PlaylistsResult
Playlists returned either as a paginated collection or as a plain list, depending on the linked_partitioning query parameter
soundcloud: SystemPlaylistsResult
SystemPlaylistsResult
System playlists returned either as a paginated collection or as a plain list, depending on the linked_partitioning query parameter
soundcloud: TracksResult
TracksResult
Tracks returned either as a paginated collection or as a plain list, depending on the linked_partitioning query parameter
Array types
soundcloud: PlaylistsArray
DeprecatedPlaylistsArray
soundcloud: TracksList
DeprecatedTracksList
soundcloud: SystemPlaylistsArray
DeprecatedSystemPlaylistsArray
soundcloud: WebProfiles
WebProfiles
User's links added to their profile
Simple name reference types
soundcloud: UploadTrackFormRequest
UploadTrackFormRequest
Import
import ballerinax/soundcloud;Metadata
Released date: about 15 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 45
Current verison: 1
Weekly downloads
Keywords
Vendor/SoundCloud
Area/Marketing & Social Media
Type/Connector
Contributors
0value