Every Public API route is an anonymous GET or HEAD on https://api.mediux.io:
no account, key or token. Paths have no version prefix, trailing slash or query
string.
- Titles and more: Shows, Movies, Collections, Games, People, Networks, Companies and Categories each have an index, a detail route and their Assets; Shows, Movies, Collections and Games also list their Sets. They appear once they have published artwork. Their text comes from TMDB or IGDB, in English only.
- Sets: the Set’s type is in the path, such as
/movie-set/{id}; show, movie and collection Sets also have YAML for Kometa. Talent, Brand and Category Sets, and the Sets routes of People, Networks, Companies and Categories, are not in the initial release. - Creators and Lists: profiles with paged content, and Public Lists.
- Feeds: the Sets changed each day, as JSON or Atom.
See Indexes, feeds and pages to go through everything, Build image URLs for artwork, and Responses and errors for the envelope and codes.
All operations
Section titled “All operations”Reference
| Method | Path | Operation |
|---|---|---|
| GET | /config | Retrieve the API configuration |
Shows
| Method | Path | Operation |
|---|---|---|
| GET | /shows/{id}/assets | Retrieve a Show's Assets |
| GET | /shows/{id}/sets | Retrieve a Show's Sets |
| GET | /shows/{id} | Retrieve a Show |
| GET | /shows | Retrieve the Show index |
| GET | /shows/chunks/{chunk} | Retrieve a Show index chunk |
Seasons
| Method | Path | Operation |
|---|---|---|
| GET | /seasons/{id}/assets | Retrieve a Season's Assets |
| GET | /seasons/{id} | Retrieve a Season |
Episodes
| Method | Path | Operation |
|---|---|---|
| GET | /episodes/{id} | Retrieve an Episode |
Movies
| Method | Path | Operation |
|---|---|---|
| GET | /movies/{id}/assets | Retrieve a Movie's Assets |
| GET | /movies/{id}/sets | Retrieve a Movie's Sets |
| GET | /movies/{id} | Retrieve a Movie |
| GET | /movies | Retrieve the Movie index |
| GET | /movies/chunks/{chunk} | Retrieve a Movie index chunk |
Collections
| Method | Path | Operation |
|---|---|---|
| GET | /collections/{id}/assets | Retrieve a Collection's Assets |
| GET | /collections/{id}/sets | Retrieve a Collection's Sets |
| GET | /collections/{id} | Retrieve a Collection |
| GET | /collections | Retrieve the Collection index |
| GET | /collections/chunks/{chunk} | Retrieve a Collection index chunk |
People
| Method | Path | Operation |
|---|---|---|
| GET | /people/{id}/assets | Retrieve a Person's Assets |
| GET | /people/{id} | Retrieve a Person |
| GET | /people | Retrieve the Person index |
| GET | /people/chunks/{chunk} | Retrieve a Person index chunk |
Networks
| Method | Path | Operation |
|---|---|---|
| GET | /networks/{id}/assets | Retrieve a Network's Assets |
| GET | /networks/{id} | Retrieve a Network |
| GET | /networks | Retrieve the Network index |
| GET | /networks/chunks/{chunk} | Retrieve a Network index chunk |
Companies
| Method | Path | Operation |
|---|---|---|
| GET | /companies/{id}/assets | Retrieve a Company's Assets |
| GET | /companies/{id} | Retrieve a Company |
| GET | /companies | Retrieve the Company index |
| GET | /companies/chunks/{chunk} | Retrieve a Company index chunk |
Categories
| Method | Path | Operation |
|---|---|---|
| GET | /categories/{id}/assets | Retrieve a Category's Assets |
| GET | /categories/{id} | Retrieve a Category |
| GET | /categories | Retrieve the Category index |
| GET | /categories/chunks/{chunk} | Retrieve a Category index chunk |
Games
| Method | Path | Operation |
|---|---|---|
| GET | /games/{id}/assets | Retrieve a Game's Assets |
| GET | /games/{id}/sets | Retrieve a Game's Sets |
| GET | /games/{id} | Retrieve a Game |
| GET | /games | Retrieve the Game index |
| GET | /games/chunks/{chunk} | Retrieve a Game index chunk |
Sets
| Method | Path | Operation |
|---|---|---|
| GET | /show-set/{id} | Retrieve a Show Set |
| GET | /movie-set/{id} | Retrieve a Movie Set |
| GET | /collection-set/{id} | Retrieve a Collection Set |
| GET | /game-set/{id} | Retrieve a Game Set |
| GET | /show-set/{id}.yaml | Retrieve Show Set YAML |
| GET | /show-set/{id}.original.yaml | Retrieve Show Set Original YAML |
| GET | /movie-set/{id}.yaml | Retrieve Movie Set YAML |
| GET | /movie-set/{id}.original.yaml | Retrieve Movie Set Original YAML |
| GET | /collection-set/{id}.yaml | Retrieve Collection Set YAML |
| GET | /collection-set/{id}.original.yaml | Retrieve Collection Set Original YAML |
Boxsets and Loadouts
| Method | Path | Operation |
|---|---|---|
| GET | /boxsets/{id} | Retrieve a Boxset |
| GET | /loadouts/{id} | Retrieve a Loadout |
Assets
| Method | Path | Operation |
|---|---|---|
| GET | /assets/{id} | Retrieve an Asset |
Profiles
| Method | Path | Operation |
|---|---|---|
| GET | /users | Retrieve the creators directory |
| GET | /users/chunks/{prefix} | Retrieve a creators directory bucket |
| GET | /users/{username} | Retrieve a User Profile |
| GET | /users/{username}/sets/pages/{page} | List a creator's Sets |
| GET | /users/{username}/boxsets/pages/{page} | List a creator's Boxsets |
| GET | /users/{username}/loadouts/pages/{page} | List a creator's Loadouts |
| GET | /users/{username}/assets/pages/{page} | List a creator's Assets |
| GET | /users/{username}/lists/pages/{page} | List a creator's Public Lists |
Lists
| Method | Path | Operation |
|---|---|---|
| GET | /lists | Retrieve the List discovery index |
| GET | /lists/chunks/{prefix} | Retrieve a List discovery bucket |
| GET | /lists/{id} | Retrieve a List |
| GET | /lists/{id}/titles/{family}/{entity} | Retrieve a List title |
Activity feeds
| Method | Path | Operation |
|---|---|---|
| GET | /feeds/media-sets | List today's Media Sets |
| GET | /feeds/media-sets/{date} | List Media Sets changed on a day |
| GET | /feeds/media-sets.atom | Retrieve the Media Set feed as Atom |
| GET | /feeds/game-sets | List today's Game Sets |
| GET | /feeds/game-sets/{date} | List Game Sets changed on a day |
| GET | /feeds/game-sets.atom | Retrieve the Game Set feed as Atom |