Documentation for the Widget Javascript API can be found here.
The Mixcloud API has been designed to be simple to use and familiar. This page has all of the information you need to get going.
Objects in the Mixcloud API can be found by taking the URL where you would find them on the site and changing https://www.mixcloud.com/ to https://api.mixcloud.com/.
Take a look at the following links in a browser to see example responses:
For example https://api.mixcloud.com/genres/funk/{
"url": "https://www.mixcloud.com/genres/funk/",
"name": "Funk shows",
"key": "/genres/funk/"
}
JSONP is supported. Adding a callback query string parameter with the name of a function wraps the response - for example https://api.mixcloud.com/genres/funk/?callback=callbackfncallback({
"url": "https://www.mixcloud.com/genres/funk/",
"name": "Funk shows",
"key": "/genres/funk/"
})
Each object has a key which is the URL (from the first /) to the object in the API.
To find out the available connections for an object add metadata=1 to the query string - for example https://api.mixcloud.com/spartacus/?metadata=1{
...
"metadata": {
"connections": {
"followers": "https://api.mixcloud.com/spartacus/followers/",
"favorites": "https://api.mixcloud.com/spartacus/favorites/",
"following": "https://api.mixcloud.com/spartacus/following/",
"cloudcasts": "https://api.mixcloud.com/spartacus/cloudcasts/",
"listens": "https://api.mixcloud.com/spartacus/listens/",
}
}
...
}
Most connections return lists of items. Other available lists are:
limit and offset query string parameters can be used to page lists.
Lists of items with dates (such as uploads) can be paged using since and until query string parameters. These parameters accept either Unix timestamps (the number of seconds since 1970-1-1) or UTC date times of the format YYYY-MM-DD HH:MM:SS.
When a list is returned URLs for the previous and next pages are provided in the response. If you would like the paging links to use offset rather than defaulting to dates, add offset=0 to the first request.
The URL https://api.mixcloud.com/me/ is a shortcut to the authorized user's information and connections. /me/ URLs are only available over https with an access token (see the Authorization section for more information).
The /search/ URL can be used to perform searches across Uploads, Users and Tags using the following URL with a type query string parameter which is either upload, user or tag and a q parameter with the search string - for example https://api.mixcloud.com/search/?q=party+time&type=cloudcast
Access tokens are required to update any data or use the /me/ shortcut and must only be provided across https connections.
Extra information is added to some objects if an access token is provided - for example a following attribute is added to a User object to indicate whether or not the authorized user is following the requested User.
The Mixcloud API uses OAuth2 for authorization.
First you'll need to create and application. Then you will be assigned a client_id and client_secret.
Only browser based authorization is supported currently. Redirect your user to
https://www.mixcloud.com/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI
where they will be given the option to log in and allow or deny your application access to their data.
If the user accepts Mixcloud will redirect the user to YOUR_REDIRECT_URI?code=OAUTH_CODE.
Once you have received the OAUTH_CODE send a request to
https://www.mixcloud.com/oauth/access_token?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&client_secret=YOUR_CLIENT_SECRET&code=OAUTH_CODE.
This will respond with an access token:access_token=YOUR_ACCESS_TOKENwhich can be used on future requests as an access_token query string parameter to access protected resources.
Note it is possible for the user to revoke their access token so your application will need to handle An invalid access token was provided errors and re-authenticate the user.
The URL for following is a User API key with follow/ on the end - for example https://api.mixcloud.com/spartacus/follow/?access_token=ACCESS_TOKEN
The URL for favoriting is an upload API key with favorite/ on the end - for example https://api.mixcloud.com/spartacus/party-time/favorite/?access_token=ACCESS_TOKEN
The URL for reposting is an upload API key with repost/ on the end - for example https://api.mixcloud.com/spartacus/party-time/repost/?access_token=ACCESS_TOKEN
The URL for adding to listen later is an upload API key with listen-later/ on the end - for example https://api.mixcloud.com/spartacus/party-time/listen-later/?access_token=ACCESS_TOKEN
To follow, favorite, repost or add to listen later an access token is required. Simply send a POST request to the URL to follow/favorite/repost/add to listen later and a DELETE request to unfollow/unfavorite/unrepost/remove from listen later. It is also possible to send a POST request with a parameter of method=delete to simulate a DELETE request.
For example:curl -X POST "https://api.mixcloud.com/spartacus/follow/?access_token=ACCESS_TOKEN"curl -X DELETE "https://api.mixcloud.com/spartacus/follow/?access_token=ACCESS_TOKEN"curl -F "method=delete" "https://api.mixcloud.com/spartacus/follow/?access_token=ACCESS_TOKEN"
Embed code for the widget can be retrieved by adding embed-html/ to an Upload API key - for example https://api.mixcloud.com/spartacus/party-time/embed-html/.
JavaScript applications (requiring JSONP for cross domain requests) can use embed-json/ instead of embed-html/ to get the HTML wrapped in JSON. width, height and color (6 digit hex code) query parameters can be used to change the widget's appearance.
Mixcloud also supports oEmbed discovery. For example you can get the embed code for an upload like this:
https://app.mixcloud.com/oembed/?url=https%3A%2F%2Fwww.mixcloud.com%2Fspartacus%2Fparty-time%2F&format=json
Shows can be uploaded by posting to https://api.mixcloud.com/upload/ with an access token (see the Authorization section).
The MP3, metadata and image should all be uploaded in a single multipart/form-data POST. The same filesize and metadata restrictions apply as in the standard Mixcloud web interface so it is recommended that applications using the Mixcloud API validate the data before sending since the user will have to wait for the MP3 to be uploaded before any validation errors are returned.
The available fields and their restrictions are shown in the table below. Fields labelled REQUIRED are required - all other fields are optional.
Tracklist/chapter information is provided using the fields in the table below where X represents the section (track or chapter) number - starting with 0.
An example, using curl, is shown below uploading an MP3 called "cloudcast.mp3", with a name of "API Upload", 2 tags ("Test" and "API"), 2 sections (a chapter called "Introduction" and one track) and an image called "upload.jpg".curl -F [email protected] \
-F "name=API Upload" \
-F "tags-0-tag=Test" \
-F "tags-1-tag=API" \
-F "sections-0-chapter=Introduction" \
-F "sections-0-start_time=0" \
-F "sections-1-artist=Artist Name" \
-F "sections-1-song=Song Title" \
-F "sections-1-start_time=10" \
-F "description=My test upload" \
https://api.mixcloud.com/upload/?access_token=INSERT_ACCESS_TOKEN_HERE
Uploads can be edited by posting to https://api.mixcloud.com/upload/[YOUR_SHOW_KEY]/edit/ (e.g. https://api.mixcloud.com/upload/my-username/my-upload/edit/) with an access token (see the Authorization section). You can edit uploads that were not uploaded with the API.
The metadata and image should all be uploaded in a single multipart/form-data POST. All fields that are allowed in an upload except mp3 can be sent to this endpoint.
The name, description and picture fields will only be updated if they are included in the request(e.g. if the description parameter is not included the description of the upload will not be changed).
If any tag fields are posted all tags will be overwritten (if you want to just add a tag, you will have to post the tags that are already on the upload for them to remain). Also for sections if any section field is posted the entire tracklist will be overwritten.
If any hosts field are posted, all hosts will be overwritten (if you want to just add one more host, you will have to post the full list of hosts that are already on the upload for them to remain).
The following extra parameters are available when editing an existing upload. You can only supply one of unlisted, publish orunpublish.
An example, using curl, is shown below:curl -F [email protected] \
-F "name=A new name" \
-F "tags-0-tag=Test" \
-F "tags-1-tag=API" \
-F "description=My test upload" \
https://api.mixcloud.com/upload/my-username/my-upload/edit/?access_token=INSERT_ACCESS_TOKEN_HERE
There are rate limits on all actions in the API. We're still tweaking these so if you keep hitting them, do let us know at here
The response in the rate limit tells you how long you have to wait until you can try again in both the HTTP headers and the JSON/XML response.HTTP/1.1 403 Forbidden
Retry-After: 452
{
"error": {
"message": "You have hit your rate limit. Retry after 452 seconds.",
"type": "RateLimitException",
"retry_after": 452
}
}
The audio streams are not available through the Mixcloud API. There are two reasons for this.
Firstly, we need to know what has been listened to so that we can report usage, pay royalties and provide features such as 'Suggested Shows'.Secondly, Mixcloud needs to pay the bills! We can't give away the audio for free outside of mixcloud.com simply because it costs us to host and stream the files and pay royalties.
Both our iOS and Android apps support deep linking using web urls. Follow the instructions below for the respective platforms:
From within your iOS app you can use the example code snippets to link to content in our app:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://www.mixcloud.com/profile/content/"];
UIApplication.sharedApplication().openURL(NSURL(string: "https://www.mixcloud.com/profile/content/")!)
UIApplication.shared.openURL(URL(string: "https://www.mixcloud.com/profile/content/")!)
You can link to content from within your android app using the following java code:
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setData(Uri.parse("https://www.mixcloud.com/profile/content/"));
context.startActivity(intent);
This will give the user the option to open the content in either a browser or the Mixcloud app if it is installed. If you want to force the content to be opened in the Mixcloud app you can also set the package on the intent:
intent.setPackage("com.mixcloud.player");