API Reference
This section describes the resources that make up Spreaker’s official APIs v2. If you have any problems or requests in regards to them, please contact our support.
Users
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/users/USER-ID |
Retrieve a single user |
GET |
/v2/me |
Retrieve the authenticated user |
POST |
/v2/users/USER-ID |
Update a user |
GET |
/v2/users/USER-ID/followers |
Retrieve a user’s followers |
GET |
/v2/users/USER-ID/followings |
Retrieve who a user follows |
PUT |
/v2/users/USER-ID/followings/FOLLOWING-ID |
Follow a user |
DELETE |
/v2/users/USER-ID/followings/FOLLOWING-ID |
Unfollow a user |
GET |
/v2/users/USER-ID/blocks |
Retrieve a user’s blocked users list |
PUT |
/v2/users/USER-ID/blocks/BLOCKED-ID |
Block a user |
DELETE |
/v2/users/USER-ID/blocks/BLOCKED-ID |
Unblock a user |
Shows
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/shows/SHOW-ID |
Retrieve a single show |
POST |
/v2/shows/SHOW-ID |
Update a show |
DELETE |
/v2/shows/SHOW-ID |
Delete a show |
POST |
/v2/shows |
Create a show |
GET |
/v2/users/USER-ID/shows |
Retrieve a user’s shows |
PUT |
/v2/users/USER-ID/favorites/SHOW-ID |
Add a show to Favorites |
DELETE |
/v2/users/USER-ID/favorites/SHOW-ID |
Remove a show from Favorites |
GET |
/v2/users/USER-ID/favorites |
Retrieve favorited shows |
Episodes
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/episodes/EPISODE-ID |
Retrieve a single episode |
POST |
/v2/episodes/EPISODE-ID |
Update an episode |
DELETE |
/v2/episodes/EPISODE-ID |
Delete an episode |
GET |
/v2/episodes/EPISODE-ID/download |
Download an episode |
GET |
/v2/episodes/EPISODE-ID/play |
Play/stream an episode |
POST |
/v2/shows/SHOW-ID/episodes |
Upload a recorded episode |
POST |
/v2/episodes/drafts |
Create a draft episode |
GET |
/v2/users/USER-ID/episodes |
Retrieve a user’s episodes |
GET |
/v2/shows/SHOW-ID/episodes |
Retrieve a show’s episodes |
PUT |
/v2/users/USER-ID/likes/EPISODE-ID |
Add an episode to Likes |
DELETE |
/v2/users/USER-ID/likes/EPISODE-ID |
Remove an episode from Likes |
GET |
/v2/users/USER-ID/likes/EPISODE-ID |
Check if an User likes an Episode |
GET |
/v2/users/USER-ID/likes |
Retrieve liked episodes |
GET |
/v2/episodes/EPISODE-ID/likes |
Retrieve users that liked an episode |
PUT |
/v2/users/USER-ID/bookmarks/EPISODE-ID |
Add an episode to your bookmarks |
DELETE |
/v2/users/USER-ID/bookmarks/EPISODE-ID |
Remove an episode from your bookmarks |
Episode Messages
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/episodes/EPISODE-ID/messages |
Retrieve an episode’s messages |
POST |
/v2/episodes/EPISODE-ID/messages |
Leave a message |
DELETE |
/v2/episodes/EPISODE-ID/messages/MESSAGE-ID |
Delete an episode’s message |
POST |
/v2/episodes/EPISODE-ID/messages/MESSAGE-ID/report-abuse |
Report abuse |
Episode Chapters
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/episodes/EPISODE-ID/chapters |
Retrieve an episode’s chapters |
POST |
/v2/episodes/EPISODE-ID/chapters |
Add a chapter |
POST |
/v2/episodes/EPISODE-ID/chapters/CHAPTER-ID |
Update a chapter |
DELETE |
/v2/episodes/EPISODE-ID/chapters/CHAPTER-ID |
Delete a single chapter |
DELETE |
/v2/episodes/EPISODE-ID/chapters |
Delete all of the episode’s chapters |
Episode Cuepoints
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/episodes/EPISODE-ID/cuepoints |
Retrieve an episode’s cuepoints |
POST |
/v2/episodes/EPISODE-ID/cuepoints |
Update an episode’s cuepoints |
DELETE |
/v2/episodes/EPISODE-ID/cuepoints |
Delete all of the episode’s cuepoints |
Statistics
User Statistics
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/users/USER-ID/statistics |
Retrieve a User’s Overall Statistics |
GET |
/v2/users/USER-ID/statistics/plays |
Retrieve a User’s Play Statistics |
GET |
/v2/users/USER-ID/statistics/likes |
Retrieve a User’s Likes Statistics |
GET |
/v2/users/USER-ID/statistics/followers |
Retrieve a User’s Followers Statistics |
GET |
/v2/users/USER-ID/statistics/sources |
Retrieve a User’s Sources Statistics |
GET |
/v2/users/USER-ID/statistics/devices |
Retrieve a User’s Devices Statistics |
GET |
/v2/users/USER-ID/statistics/os |
Retrieve a User’s Operating Systems Statistics |
GET |
/v2/users/USER-ID/statistics/geographics |
Retrieve a User’s Geographic Statistics |
Show Statistics
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/shows/SHOW-ID/statistics |
Retrieve a Show’s Overall Statistics |
GET |
/v2/shows/SHOW-ID/statistics/plays |
Retrieve a Show’s Play Statistics |
GET |
/v2/shows/SHOW-ID/statistics/likes |
Retrieve a Show’s Likes Statistics |
GET |
/v2/shows/SHOW-ID/statistics/sources |
Retrieve a Show’s Sources Statistics |
GET |
/v2/shows/SHOW-ID/statistics/devices |
Retrieve a Show’s Devices Statistics |
GET |
/v2/shows/SHOW-ID/statistics/os |
Retrieve a Show’s Operating Systems Statistics |
GET |
/v2/shows/SHOW-ID/statistics/geographics |
Retrieve a Show’s Geographic Statistics |
GET |
/v2/users/USER-ID/shows/statistics/plays/totals |
Retrieve a User’s Shows’ Total Play Statistics |
Episode Statistics
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/episodes/EPISODE-ID/statistics |
Retrieve an Episode’s Overall Statistics |
GET |
/v2/episodes/EPISODE-ID/statistics/plays |
Retrieve an Episode’s Play Statistics |
GET |
/v2/episodes/EPISODE-ID/statistics/likes |
Retrieve an Episode’s Likes Statistics |
GET |
/v2/episodes/EPISODE-ID/statistics/sources |
Retrieve an Episode’s Sources Statistics |
GET |
/v2/episodes/EPISODE-ID/statistics/devices |
Retrieve an Episode’s Devices Statistics |
GET |
/v2/episodes/EPISODE-ID/statistics/os |
Retrieve an Episode’s Operating Systems Statistics |
GET |
/v2/shows/SHOW-ID/episodes/statistics/plays/totals |
Retrieve a Show’s Episodes’ Total Play Statistics |
Search
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/search?type=shows |
Search shows |
GET |
/v2/search?type=episodes |
Search episodes |
GET |
/v2/search/users/USER-ID?type=shows |
Search shows by author |
GET |
/v2/search/users/USER-ID?type=episodes |
Search episodes by author |
GET |
/v2/search/shows/SHOW-ID?type=episodes |
Search episodes by show |
Explore
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/explore/lists |
Retrieve Curated Lists |
GET |
/v2/explore/lists/LIST-ID |
Retrieve a Single Curated List |
GET |
/v2/explore/lists/LIST-ID/items |
Retrieve a Curated List’s Items |
GET |
/v2/explore/categories/CATEGORY-ID/items |
Retrieving a Category’s items |
Tags
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/tags/TAG-NAME/episodes |
Retrieve the Latest Episodes by Tag name |
Miscellaneous
| Method | URL | Functionality |
|---|---|---|
GET |
/v2/show-categories |
List of show categories |
GET |
/v2/show-languages |
List of show languages |
Widgets
The widget is a player you can embed in your own website or blog. The easiest way to configure the widget and generate the markup to embed is through our CMS but there’s some people who needs to manually generate it or control it via JavaScript, so we’ve created a dedicated guide.
| Method | URL | Functionality |
|---|---|---|
GET |
/oembed |
oEmbed Provider |