Skip to content
MediuxDocs

Public API

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.

Reference

MethodPathOperation
GET/configRetrieve the API configuration

Shows

MethodPathOperation
GET/shows/{id}/assetsRetrieve a Show's Assets
GET/shows/{id}/setsRetrieve a Show's Sets
GET/shows/{id}Retrieve a Show
GET/showsRetrieve the Show index
GET/shows/chunks/{chunk}Retrieve a Show index chunk

Seasons

MethodPathOperation
GET/seasons/{id}/assetsRetrieve a Season's Assets
GET/seasons/{id}Retrieve a Season

Episodes

MethodPathOperation
GET/episodes/{id}Retrieve an Episode

Movies

MethodPathOperation
GET/movies/{id}/assetsRetrieve a Movie's Assets
GET/movies/{id}/setsRetrieve a Movie's Sets
GET/movies/{id}Retrieve a Movie
GET/moviesRetrieve the Movie index
GET/movies/chunks/{chunk}Retrieve a Movie index chunk

Collections

MethodPathOperation
GET/collections/{id}/assetsRetrieve a Collection's Assets
GET/collections/{id}/setsRetrieve a Collection's Sets
GET/collections/{id}Retrieve a Collection
GET/collectionsRetrieve the Collection index
GET/collections/chunks/{chunk}Retrieve a Collection index chunk

People

MethodPathOperation
GET/people/{id}/assetsRetrieve a Person's Assets
GET/people/{id}Retrieve a Person
GET/peopleRetrieve the Person index
GET/people/chunks/{chunk}Retrieve a Person index chunk

Networks

MethodPathOperation
GET/networks/{id}/assetsRetrieve a Network's Assets
GET/networks/{id}Retrieve a Network
GET/networksRetrieve the Network index
GET/networks/chunks/{chunk}Retrieve a Network index chunk

Companies

MethodPathOperation
GET/companies/{id}/assetsRetrieve a Company's Assets
GET/companies/{id}Retrieve a Company
GET/companiesRetrieve the Company index
GET/companies/chunks/{chunk}Retrieve a Company index chunk

Categories

MethodPathOperation
GET/categories/{id}/assetsRetrieve a Category's Assets
GET/categories/{id}Retrieve a Category
GET/categoriesRetrieve the Category index
GET/categories/chunks/{chunk}Retrieve a Category index chunk

Games

MethodPathOperation
GET/games/{id}/assetsRetrieve a Game's Assets
GET/games/{id}/setsRetrieve a Game's Sets
GET/games/{id}Retrieve a Game
GET/gamesRetrieve the Game index
GET/games/chunks/{chunk}Retrieve a Game index chunk

Sets

MethodPathOperation
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}.yamlRetrieve Show Set YAML
GET/show-set/{id}.original.yamlRetrieve Show Set Original YAML
GET/movie-set/{id}.yamlRetrieve Movie Set YAML
GET/movie-set/{id}.original.yamlRetrieve Movie Set Original YAML
GET/collection-set/{id}.yamlRetrieve Collection Set YAML
GET/collection-set/{id}.original.yamlRetrieve Collection Set Original YAML

Boxsets and Loadouts

MethodPathOperation
GET/boxsets/{id}Retrieve a Boxset
GET/loadouts/{id}Retrieve a Loadout

Assets

MethodPathOperation
GET/assets/{id}Retrieve an Asset

Profiles

MethodPathOperation
GET/usersRetrieve 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

MethodPathOperation
GET/listsRetrieve 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

MethodPathOperation
GET/feeds/media-setsList today's Media Sets
GET/feeds/media-sets/{date}List Media Sets changed on a day
GET/feeds/media-sets.atomRetrieve the Media Set feed as Atom
GET/feeds/game-setsList today's Game Sets
GET/feeds/game-sets/{date}List Game Sets changed on a day
GET/feeds/game-sets.atomRetrieve the Game Set feed as Atom