Module soundcloud
ballerinax/soundcloud Ballerina library
1.5.2
Overview
The SoundCloud API v1.0.0 connector(https://developers.soundcloud.com/) OpenAPI Specification.
SoundCloud API provides capability to access the online audio distribution platform and music sharing website that enables you to upload,promote, and share audio, as well as a digital signal processor enabling listeners to stream audio.
Clients
soundcloud: Client
Isolated
This is a generated connector for SoundCloud API v1.0.0 OpenAPI Specification. SoundCloud API provides capability to access the online audio distribution platform and music sharing website that enables you to upload,promote, and share audio, as well as a digital signal processor enabling listeners to stream audio.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an SoundCloud account and obtain tokens following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.soundcloud.com" - URL of the target service
likePlaylist
Isolated FunctionRemote Function
Likes a playlist.
Parameters
- playlistId int - SoundCloud playlist id
Return Type
- json|error - Success
unlikePlaylist
Isolated FunctionRemote Function
Unlikes a playlist.
Parameters
- playlistId int - SoundCloud playlist id
Return Type
- json|error - Success
likeTrack
Isolated FunctionRemote Function
Likes a track.
Parameters
- trackId int - SoundCloud Track id
Return Type
- json|error - Success
unlikeTrack
Isolated FunctionRemote Function
Unlikes a track.
Parameters
- trackId int - SoundCloud Track id
Return Type
- json|error - Success
getUserDetail
Isolated FunctionRemote Function
function getUserDetail() returns CompleteUser|errorReturns the authenticated user’s information.
Return Type
- CompleteUser|error - Success
getActivities
Isolated FunctionRemote Function
function getActivities(string[]? access, int 'limit) returns Activities|errorReturns the authenticated user's activities.
Parameters
- access string[]? (default ()) - 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.
Return Type
- Activities|error - Success
getOwnActivities
Isolated FunctionRemote Function
function getOwnActivities(string[]? access, int 'limit) returns Activities|errorRecent the authenticated user's activities.
Parameters
- access string[]? (default ()) - 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.
Return Type
- Activities|error - Success
getRecentTrackRelatedActivities
Isolated FunctionRemote Function
function getRecentTrackRelatedActivities(string[]? access, int 'limit) returns Activities|errorReturns the authenticated user's recent track related activities.
Parameters
- access string[]? (default ()) - 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.
Return Type
- Activities|error - Success
listConnectedSocialAccounts
Isolated FunctionRemote Function
function listConnectedSocialAccounts(int 'limit, int offset) returns Connections|errorReturns a list of the authenticated user's connected social accounts.
Parameters
- 'limit int (default 50) - Number of results to return in the collection.
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- Connections|error - Success
Deprecated parameters
getConnectionByID
Isolated FunctionRemote Function
function getConnectionByID(int connectionId) returns Connection|errorReturns the authenticated user's connected social account.
Parameters
- connectionId int - SoundCloud connection id
Return Type
- Connection|error - Success
getFollowers
Isolated FunctionRemote Function
function getFollowers(int 'limit) returns InlineResponse200|errorReturns a list of users who are following the authenticated user.
Parameters
- 'limit int (default 50) - Number of results to return in the collection.
Return Type
- InlineResponse200|error - Success
listFollowings
Isolated FunctionRemote Function
function listFollowings(int 'limit, int offset) returns InlineResponse200|errorReturns a list of users who are followed by the authenticated user.
Parameters
- 'limit int (default 50) - Number of results to return in the collection.
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- InlineResponse200|error - Success
Deprecated parameters
listRecentTracks
Isolated FunctionRemote Function
function listRecentTracks(string[]? access, int 'limit, int offset) returns TracksList|errorReturns a list of recent tracks from users followed by the authenticated user.
Parameters
- access string[]? (default ()) - 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.
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- TracksList|error - Success
Deprecated parameters
followUser
Isolated FunctionRemote Function
Follows a user.
Parameters
- userId int - SoundCloud User id
deleteFollowing
Isolated FunctionRemote Function
Deletes a user who is followed by the authenticated user.
Parameters
- userId int - SoundCloud User id
Return Type
- json|error - Success
listLikedTracks
Isolated FunctionRemote Function
function listLikedTracks(int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|errorReturns a list of favorites or liked tracks of the authenticated user.
Parameters
- 'limit int (default 50) - Number of results to return in the collection.
- linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
- InlineResponse2001|error - Success
listPlaylist
Isolated FunctionRemote Function
function listPlaylist(int 'limit) returns PlaylistsArray|errorReturns user’s playlists (sets).
Parameters
- 'limit int (default 50) - Number of results to return in the collection.
Return Type
- PlaylistsArray|error - Success
listTracks
Isolated FunctionRemote Function
function listTracks(int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|errorReturns a list of user's tracks.
Parameters
- 'limit int (default 50) - Number of results to return in the collection.
- linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
- InlineResponse2001|error - Success
searchPlaylist
Isolated FunctionRemote Function
function searchPlaylist(string q, string[]? access, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2002|errorPerforms a playlist search based on a query
Parameters
- q string - search
- access string[]? (default ()) - 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? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- InlineResponse2002|error - Success
Deprecated parameters
createPlaylist
Isolated FunctionRemote Function
function createPlaylist(CreateUpdatePlaylistRequest payload) returns InlineResponse201|errorCreates a playlist.
Parameters
- payload CreateUpdatePlaylistRequest - Create Playlist request
Return Type
- InlineResponse201|error - Success
getPlaylist
Isolated FunctionRemote Function
Returns a playlist.
Parameters
- playlistId int - SoundCloud playlist id
- secretToken string? (default ()) - A secret token to fetch private playlists/tracks
- access string[]? (default ()) - 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.
updatePlaylist
Isolated FunctionRemote Function
function updatePlaylist(int playlistId, CreateUpdatePlaylistRequest payload) returns InlineResponse201|errorUpdates a playlist.
Parameters
- playlistId int - SoundCloud playlist id
- payload CreateUpdatePlaylistRequest - Playlist payload
Return Type
- InlineResponse201|error - Success
deletePlaylist
Isolated FunctionRemote Function
Deletes a playlist.
Parameters
- playlistId int - SoundCloud playlist id
listReposts
Isolated FunctionRemote Function
Returns a collection of playlist's reposters.
Parameters
- playlistId int - SoundCloud playlist id
- 'limit int (default 50) - Number of results to return in the collection.
getTracksUnderPlaylist
Isolated FunctionRemote Function
function getTracksUnderPlaylist(int playlistId, string? secretToken, string[]? access, boolean? linkedPartitioning) returns InlineResponse2001|errorReturns tracks under a playlist.
Parameters
- playlistId int - SoundCloud playlist id
- secretToken string? (default ()) - A secret token to fetch private playlists/tracks
- access string[]? (default ()) - 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.
- linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
- InlineResponse2001|error - Success
repostPlaylist
Isolated FunctionRemote Function
Reposts a playlist as the authenticated user
Parameters
- playlistId int - SoundCloud playlist id
deleteRepost
Isolated FunctionRemote Function
Removes a repost on a playlist as the authenticated user
Parameters
- playlistId int - SoundCloud playlist id
repostTrackByTrackID
Isolated FunctionRemote Function
Reposts a track as the authenticated user
Parameters
- trackId int - SoundCloud Track id
deleteRepostOnTrack
Isolated FunctionRemote Function
Removes a repost on a track as the authenticated user
Parameters
- trackId int - SoundCloud Track id
resolveSoundCloudURLToResourceURL
Isolated FunctionRemote Function
Resolves soundcloud.com URLs to Resource URLs to use with the API.
Parameters
- url string - SoundCloud URL
searchTracks
Isolated FunctionRemote Function
function searchTracks(string q, string? ids, string? genres, string? tags, string[]? access, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2001|errorPerforms a track search based on a query
Parameters
- q string - search
- ids string? (default ()) - A comma separated list of track ids to filter on
- genres string? (default ()) - A comma separated list of genres
- tags string? (default ()) - A comma separated list of tags
- access string[]? (default ()) - 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? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- InlineResponse2001|error - Success
Deprecated parameters
getTrackByID
Isolated FunctionRemote Function
Returns a track.
Parameters
- trackId int - SoundCloud Track id
- secretToken string? (default ()) - A secret token to fetch private playlists/tracks
deleteTrack
Isolated FunctionRemote Function
Deletes a track.
Parameters
- trackId int - SoundCloud Track id
getCommentsOnTrack
Isolated FunctionRemote Function
function getCommentsOnTrack(int trackId, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2003|errorReturns the comments posted on the track(track_id).
Parameters
- trackId int - SoundCloud Track id
- 'limit int (default 50) - Number of results to return in the collection.
- linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- InlineResponse2003|error - Success
Deprecated parameters
addComment
Isolated FunctionRemote Function
function addComment(int trackId, TrackIdCommentsBody payload) returns Comment|errorReturns the newly created comment on success
getLikedUsersOfTrack
Isolated FunctionRemote Function
Returns a list of users who have favorited or liked the track.
Parameters
- trackId int - SoundCloud Track id
- 'limit int (default 50) - Number of results to return in the collection.
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Deprecated parameters
listRelatedTracksOfTrack
Isolated FunctionRemote Function
function listRelatedTracksOfTrack(int trackId, string[]? access, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2001|errorReturns all related tracks of track on SoundCloud.
Parameters
- trackId int - SoundCloud Track id
- access string[]? (default ()) - 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? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- InlineResponse2001|error - Success
Deprecated parameters
getRepostCollection
Isolated FunctionRemote Function
Returns a collection of track's reposters.
Parameters
- trackId int - SoundCloud Track id
- 'limit int (default 50) - Number of results to return in the collection.
getStreambleURL
Isolated FunctionRemote Function
Returns a track's streamable URLs
Parameters
- trackId int - SoundCloud Track id
- secretToken string? (default ()) - A secret token to fetch private playlists/tracks
searchUser
Isolated FunctionRemote Function
function searchUser(string q, string? ids, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse200|errorPerforms a user search based on a query
Parameters
- q string - search
- ids string? (default ()) - A comma separated list of track ids to filter on
- 'limit int (default 50) - Number of results to return in the collection.
- linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- InlineResponse200|error - Success
Deprecated parameters
getUserByID
Isolated FunctionRemote Function
function getUserByID(int userId) returns CompleteUser|errorReturns a user.
Parameters
- userId int - SoundCloud User id
Return Type
- CompleteUser|error - Success
listUserComments
Isolated FunctionRemote Function
function listUserComments(int userId, int 'limit, int offset) returns CommentsList|errorReturns a list of user's comments.
Parameters
- userId int - SoundCloud User id
- 'limit int (default 50) - Number of results to return in the collection.
- offset int (default 0) - Offset of first result. Deprecated, use
linked_partitioninginstead.Deprecated parameters
Deprecated
Return Type
- CommentsList|error - Success
Deprecated parameters
listFollowers
Isolated FunctionRemote Function
function listFollowers(int userId, int 'limit) returns InlineResponse200|errorReturns a list of user’s followers.
Parameters
- userId int - SoundCloud User id
- 'limit int (default 50) - Number of results to return in the collection.
Return Type
- InlineResponse200|error - Success
listUserFollowings
Isolated FunctionRemote Function
function listUserFollowings(int userId, int 'limit) returns InlineResponse200|errorReturns a list of user’s followings.
Parameters
- userId int - SoundCloud User id
- 'limit int (default 50) - Number of results to return in the collection.
Return Type
- InlineResponse200|error - Success
listUserLikedTracks
Isolated FunctionRemote Function
function listUserLikedTracks(int userId, string[]? access, int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|errorReturns a list of user's liked tracks.
Parameters
- userId int - SoundCloud User id
- access string[]? (default ()) - 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? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
- InlineResponse2001|error - Success
listUserPlaylist
Isolated FunctionRemote Function
function listUserPlaylist(int userId, string[]? access, int 'limit, boolean? linkedPartitioning) returns InlineResponse2002|errorReturns a list of user's playlists.
Parameters
- userId int - SoundCloud User id
- access string[]? (default ()) - 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? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
- InlineResponse2002|error - Success
listUserTracks
Isolated FunctionRemote Function
function listUserTracks(int userId, string[]? access, int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|errorReturns a list of user's tracks.
Parameters
- userId int - SoundCloud User id
- access string[]? (default ()) - 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? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
- InlineResponse2001|error - Success
listUserLinks
Isolated FunctionRemote Function
function listUserLinks(int userId, int 'limit) returns WebProfiles|errorReturns list of user's links added to their profile (website, facebook, instagram).
Parameters
- userId int - SoundCloud User id
- 'limit int (default 50) - Number of results to return in the collection.
Return Type
- WebProfiles|error - Success
Records
soundcloud: Activities
User's activities.
Fields
- collection? ActivitiesCollection[] -
- future_href? string -
- next_href? string -
soundcloud: ActivitiesCollection
Fields
- created_at? string - Created timestamp.
- 'type? string - Type of activity (track).
soundcloud: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
soundcloud: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
soundcloud: Comment
User's Comment
Fields
- body? string - Comment body.
- created_at? string - Created timestamp.
- id? int - Identifier.
- kind? string - Kind (comment).
- timestamp? string - Timestamp.
- track_id? int - Track's identifier.
- uri? string - Comment's URL.
- user? CommentUser - SoundCloud User object
- user_id? int - User's identifier.
soundcloud: Comments
Fields
- collection? Comment[] -
- next_href? string? -
soundcloud: CommentUser
SoundCloud User object
Fields
- avatar_url? string - URL to a JPEG image.
- followers_count? int - number of followers.
- followings_count? int - number of followed users.
- id? int - unique identifier
- kind? string - kind of resource.
- last_modified? string - last modified timestamp.
- permalink? string - permalink of the resource.
- permalink_url? string - URL to the SoundCloud.com page.
- reposts_count? int - number of reposts from user
- uri? string - API resource URL.
- username? string - username
soundcloud: CompleteUser
SoundCloud Complete User object
Fields
- avatar_url? string - URL to a JPEG image.
- city? string - city.
- country? string - country.
- description? string - description.
- discogs_name? string - discogs name.
- first_name? string - first name.
- followers_count? int - number of followers.
- followings_count? int - number of followed users.
- full_name? string - first and last name.
- id? int - unique identifier
- kind? string - kind of resource.
- last_modified? string - last modified timestamp.
- last_name? string - last name.
- locale? string - locale.
- myspace_name? string - myspace name
- permalink? string - permalink of the resource.
- permalink_url? string - URL to the SoundCloud.com page.
- plan? string - subscription plan of the user.
- playlist_count? int - number of public playlists.
- primary_email_confirmed? boolean - boolean if email is confirmed.
- private_playlists_count? int - number of private playlists.
- private_tracks_count? int - number of private tracks.
- public_favorites_count? int - number of favorited public tracks
- quota? CompleteuserQuota - user's upload quota
- reposts_count? int - number of reposts from user
- subscriptions? anydata[][] - a list subscriptions associated with the user
- track_count? int - number of public tracks.
- uri? string - API resource URL.
- username? string - username
- website? string - a URL to the website.
- website_title? string - a custom title for the website.
soundcloud: CompleteuserQuota
user's upload quota
Fields
- unlimited_upload_quota? boolean - unlimited upload quota.
- upload_seconds_used? int - upload seconds used.
soundcloud: Connection
Fields
- created_at? string - Created timestamp.
- display_name? string - Full Name.
- id? int - Unique identifier
- kind? string - Kind of resource.
- post_favorite? boolean -
- post_publish? boolean -
- 'service? string - Service.
- 'type? string - Type.
- uri? string - The external link URI.
soundcloud: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - 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
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - 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
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
soundcloud: CreateUpdatePlaylistRequest
Fields
- playlist? CreateupdateplaylistrequestPlaylist -
soundcloud: CreateupdateplaylistrequestPlaylist
Fields
- description? string - Description of the playlist
- title? string - Title of the playlist
- tracks? CreateupdateplaylistrequestPlaylistTracks[] - List of tracks to add to playlist
soundcloud: CreateupdateplaylistrequestPlaylistTracks
Fields
- id string - SoundCloud track id
soundcloud: Error
Fields
- code? int -
- 'error? string? -
- errors? anydata[] -
- link? string -
- message? string -
- status? string -
soundcloud: Found
Fields
- location? string - Location URL of the resource.
- status? string - Status code.
soundcloud: InlineResponse201
Soundcloud Playlist Object
Fields
- artwork_url? string - URL to a JPEG image.
- created_at? string - Created timestamp.
- description? string - Playlist description.
- downloadable? boolean - is downloadable.
- duration? int - Playlist duration.
- ean? string - European Article Number.
- embeddable_by? string - Embeddable by.
- genre? string - Playlist genre.
- id? int - Playlist identifier.
- kind? string - Type of Soundcloud object (playlist).
- label_id? int - Label user identifier.
- label_name? string - Label name.
- last_modified? string - Last modified timestamp.
- license? string - License.
- permalink? string - Playlist permalink.
- permalink_url? string - Playlist permalink URL.
- playlist_type? string - Type of playlist.
- purchase_title? string - Purchase title.
- purchase_url? string - Purchase URL.
- release? string - Release.
- release_day? int - Day of release.
- release_month? int - Month of release.
- release_year? int - Year of release.
- streamable? boolean - Is streamable.
- tag_list? string - Tags.
- title? string - Playlist title.
- track_count? int - Count of tracks.
- tracks? InlineResponse201Tracks[] - List of tracks.
- 'type? string - Playlist type.
- uri? string - Playlist URI.
- user? MetaUser? - SoundCloud User object.
- user_id? int - User identifier.
soundcloud: InlineResponse201Tracks
Soundcloud Track object.
Fields
- artwork_url? string - URL to a JPEG image.
- bpm? int - Tempo.
- comment_count? int - Number of comments.
- commentable? boolean - Is commentable.
- created_at? string - Created timestamp.
- description? string - Track description.
- download_count? int - NUmber of downloads.
- downloadable? string - Is downloadable.
- duration? int - Track duration.
- embeddable_by? string - Embeddable by.
- favoritings_count? int - Number of favoritings.
- genre? string - Genre
- id? int - Track identifier.
- isrc? string - ISRC code.
- key_signature? string - Key signature.
- kind? string - Type of object (track).
- label_name? string - Label user name.
- license? string - License
- permalink_url? string - Permalink URL.
- playback_count? int - Number of plays.
- purchase_title? string - Purchase title.
- purchase_url? string - Purchase URL.
- release? string - Release.
- release_day? int - Day of release.
- release_month? int - Month of release.
- release_year? int - Year of release.
- stream_url? string - URL to stream.
- streamable? boolean - Is streamable.
- tag_list? string - Tags.
- title? string - Track title.
- uri? string - Track URI.
- user? MetaUser? - SoundCloud User object.
- user_favorite? boolean - Is user's favourite.
- user_playback_count? int - Number of plays by a user.
- waveform_url? string - Waveform URL.
soundcloud: MetaUser
SoundCloud User object.
Fields
- avatar_url? string - URL to a JPEG image
- created_at? string - profile creation datetime
- id? int - unique identifier
- kind? string - kind of resource
- last_modified? string - last modified datetime
- permalink? string - permalink of the resource
- permalink_url? string - URL to the SoundCloud.com page
- uri? string - API resource URL
- username? string - username
soundcloud: MetaUsers
Fields
- collection? MetaUser[] -
- next_href? string -
soundcloud: Playlist
Soundcloud Playlist Object
Fields
- artwork_url? string - URL to a JPEG image.
- created_at? string - Created timestamp.
- description? string - Playlist description.
- downloadable? boolean - is downloadable.
- duration? int - Playlist duration.
- ean? string - European Article Number.
- embeddable_by? string - Embeddable by.
- genre? string - Playlist genre.
- id? int - Playlist identifier.
- kind? string - Type of Soundcloud object (playlist).
- label? MetaUser? - SoundCloud User object.
- label_id? int - Label user identifier.
- label_name? string - Label name.
- last_modified? string - Last modified timestamp.
- license? string - License.
- likes_count? int - Count of playlist likes.
- permalink? string - Playlist permalink.
- permalink_url? string - Playlist permalink URL.
- playlist_type? string - Type of playlist.
- purchase_title? string - Purchase title.
- purchase_url? string - Purchase URL.
- release? string - Release.
- release_day? int - Day of release.
- release_month? int - Month of release.
- release_year? int - Year of release.
- streamable? boolean - Is streamable.
- tag_list? string - Tags.
- title? string - Playlist title.
- track_count? int - Count of tracks.
- tracks? Track[] - List of tracks.
- tracks_uri? string? - tracks URI.
- 'type? string - Playlist type.
- uri? string - Playlist URI.
- user? MetaUser? - SoundCloud User object.
- user_id? int - User identifier.
soundcloud: Playlists
Fields
- collection? Playlist[] -
- next_href? string -
soundcloud: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
soundcloud: Streams
Fields
- hls_mp3_128_url? string -
- hls_opus_64_url? string -
- http_mp3_128_url? string -
- preview_mp3_128_url? string -
soundcloud: TooManyRequests
Fields
- Fields Included from *Error
- spam_warning_urn? string -
soundcloud: Track
Soundcloud Track object.
Fields
- access? string? - 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
- artwork_url? string - URL to a JPEG image.
- available_country_codes? string - List of countries where track is available.
- bpm? int - Tempo.
- comment_count? int - Number of comments.
- commentable? boolean - Is commentable.
- created_at? string - Created timestamp.
- description? string - Track description.
- download_count? int - NUmber of downloads.
- download_url? string - URL to download a track.
- downloadable? string - Is downloadable.
- duration? int - Track duration.
- embeddable_by? string - Embeddable by.
- favoritings_count? int - Number of favoritings.
- genre? string - Genre
- id? int - Track identifier.
- isrc? string - ISRC code.
- key_signature? string - Key signature.
- kind? string - Type of object (track).
- label_name? string - Label user name.
- license? string - License
- permalink_url? string - Permalink URL.
- playback_count? int - Number of plays.
- purchase_title? string - Purchase title.
- purchase_url? string - Purchase URL.
- release? string - Release.
- release_day? int - Day of release.
- release_month? int - Month of release.
- release_year? int - Year of release.
- reposts_count? int - Number of reposts.
- secret_uri? string - Secret URL.
- stream_url? string - URL to stream.
- streamable? boolean - Is streamable.
- tag_list? string - Tags.
- title? string - Track title.
- uri? string - Track URI.
- user? MetaUser? - SoundCloud User object.
- user_favorite? boolean - Is user's favourite.
- user_playback_count? int - Number of plays by a user.
- waveform_url? string - Waveform URL.
soundcloud: TrackDataRequest
Fields
- 'track\[artwork\_data\]? string -
- 'track\[asset\_data\]? string -
- 'track\[commentable\]? boolean -
- 'track\[description\]? string -
- 'track\[downloadable\]? boolean -
- 'track\[embeddable\_by\]? string - who can embed this track "all", "me", or "none"
- 'track\[genre\]? string -
- 'track\[isrc\]? string -
- 'track\[label\_name\]? string -
- 'track\[license\]? string - 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
- 'track\[permalink\]? string -
- 'track\[purchase\_url\]? string -
- 'track\[release\]? string -
- 'track\[release\_date\]? string - string, formatted as yyyy-mm-dd, representing release date
- 'track\[sharing\]? string -
- 'track\[streamable\]? boolean -
- 'track\[tag\_list\]? 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.
- 'track\[title\]? string -
soundcloud: TrackIdCommentsBody
Fields
- comment? TrackstrackIdcommentsComment -
soundcloud: TrackMetadataRequest
Fields
- track? TrackmetadatarequestTrack -
soundcloud: TrackmetadatarequestTrack
Fields
- commentable? boolean -
- description? string -
- downloadable? boolean -
- embeddable_by? string - who can embed this track "all", "me", or "none"
- genre? string -
- isrc? string -
- label_name? string -
- license? string - 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
- permalink? string -
- purchase_url? string -
- release? string -
- release_date? string - string, formatted as yyyy-mm-dd, representing release date
- streamable? boolean -
- tag_list? 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.
- title? string -
soundcloud: Tracks
Fields
- collection? Track[] -
- next_href? string -
soundcloud: TrackstrackIdcommentsComment
Fields
- body string - Comment's content
soundcloud: User
SoundCloud User object
Fields
- avatar_url? string - URL to a JPEG image
- city? string - city
- country? string - country
- created_at? string - profile creation datetime
- description? string - description
- discogs_name? string - discogs name
- first_name? string - first name
- followers_count? int - number of followers
- followings_count? int - number of followed users
- full_name? string - first and last name
- id? int - unique identifier
- kind? string - kind of resource
- last_modified? string - last modified datetime
- last_name? string - last name
- myspace_name? string - myspace name
- permalink? string - permalink of the resource
- permalink_url? string - URL to the SoundCloud.com page
- plan? string - subscription plan of the user
- playlist_count? int - number of public playlists
- public_favorites_count? int - number of favorited public tracks
- reposts_count? int - number of reposts from user
- subscriptions? anydata[][] - a list subscriptions associated with the user
- track_count? int - number of public tracks
- uri? string - API resource URL
- username? string - username
- website? string - a URL to the website
- website_title? string - a custom title for the website
soundcloud: Users
Fields
- collection? User[] -
- next_href? string -
soundcloud: UserslistInner
SoundCloud User object
Fields
- avatar_url? string - URL to a JPEG image
- city? string - city
- country? string - country
- description? string - description
- discogs_name? string - discogs name
- first_name? string - first name
- followers_count? int - number of followers
- followings_count? int - number of followed users
- full_name? string - first and last name
- id? int - unique identifier
- kind? string - kind of resource
- last_modified? string - last modified datetime
- last_name? string - last name
- myspace_name? string - myspace name
- permalink? string - permalink of the resource
- permalink_url? string - URL to the SoundCloud.com page
- plan? string - subscription plan of the user
- playlist_count? int - number of public playlists
- public_favorites_count? int - number of favorited public tracks
- reposts_count? int - number of reposts from user
- subscriptions? anydata[][] - a list subscriptions associated with the user
- track_count? int - number of public tracks
- uri? string - API resource URL
- username? string - username
- website? string - a URL to the website
- website_title? string - a custom title for the website
soundcloud: WebprofilesInner
Fields
- created_at? string - Timestamp of when the link was added to the profile.
- id? int - Id
- kind? string - Kind
- 'service? string - Service or platform
- title? string - Link's title
- url? string - URL of the external link
- username? string - Username extracted from the external link
Union types
soundcloud: InlineResponse2001
InlineResponse2001
soundcloud: InlineResponse2003
InlineResponse2003
soundcloud: InlineResponse2002
InlineResponse2002
Array types
soundcloud: Connections
Connections
soundcloud: UsersList
DeprecatedUsersList
soundcloud: PlaylistsArray
DeprecatedPlaylistsArray
soundcloud: TracksList
DeprecatedTracksList
soundcloud: CommentsList
DeprecatedCommentsList
soundcloud: WebProfiles
WebProfiles
User's links added to their profile