BetaSeries: shows

Call the BetaSeries "shows" API. Pick an operation and pass its parameters in the params object.

Available operations:

• delete-shows-archive [DELETE /shows/archive]: Remove a series from the archives of the member's account. Params: id? (ID of the series (Optional if thetvdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id specified))

• delete-shows-favorite [DELETE /shows/favorite]: Remove a favorite series from the profile of the identified member. Params: id? (ID of the series to remove.)

• delete-shows-note [DELETE /shows/note]: Delete a series rating. Params: id? (ID of the series (Optional if thetvdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id specified))

• delete-shows-recommendation [DELETE /shows/recommendation]: Delete a sent or received series recommendation. Params: id? (Recommendation ID)

• delete-shows-rewatch [DELETE /shows/rewatch]: Delete each rewatch an entire show. Params: id? (Series ID.), all? (Remove all rewatch for the given show (int 0|1))

• delete-shows-show [DELETE /shows/show]: Remove a series from the member's account. Params: id? (ID of the series (Optional if thetvdb_id or imdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id or imdb_id specified)), imdb_id? (ID of the series on IMDB (Optional if thetvdb_id or id specified))

• delete-shows-watch [DELETE /shows/watch]: Remove watch for an entire show. Params: id? (Series ID.)

• get-shows-articles [GET /shows/articles]: Display blog articles that talk about the series. Params: id? (Series ID (Optional if url specified)), url? (Series URL. (Optional))

• get-shows-characters [GET /shows/characters]: Retrieve characters of the series. Params: id? (Series ID (Optional if thetvdb_id specified)), thetvdb_id? (Series ID on TheTVDB (Optional if id specified))

• get-shows-discover [GET /shows/discover]: Display the list of series to discover. Params: limit? (Limit the number of series to display (optional, default 100, maximum 200)), offset? (Starting number for the series list (optional, default 0)), summary? (Return only essential information)

• get-shows-discover-platforms [GET /shows/discover_platforms]: Display the list of series to discover on major SVoD platforms. Params: summary? (Return only essential information)

• get-shows-display [GET /shows/display]: Display information about a series. Params: id? (Series ID. You can include multiple by separating them with a comma (Optional)), thetvdb_id? (Series ID on TheTVDB. You can include multiple by separating them with a comma (Optional)), imdb_id? (Series ID on IMDB. You can include multiple by separating them with a comma (Optional)), url? (Series URL. (Optional)), summary(default=false)? (Return only the essential information of the series.), includes? (If summary = true, add some additional blocks to the return: user, notes separated by a comma (optional).)

• get-shows-episodes [GET /shows/episodes]: Display episodes of a series. Params: id? (ID of the series (Optional if thetvdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id specified)), season? (Season number (Optional)), episode? (Episode number (Optional)), subtitles? (Display subtitles if specified (Optional))

• get-shows-favorites [GET /shows/favorites]: Retrieve the favorite series of the member. Params: id? (Member's ID, optional, if not specified uses the identified member.), order? (Specify return order: alphabetical, progression, remaining_time, remaining_episodes (optional, default alphabetical)), limit? (Limit the number of series to display (optional, default 100, maximum 200)), offset? (Starting number for the series list (optional, default 0)), status? (Filter series by status: current, active, archived (optional)), summary? (Return only essential series info), includes? (If summary = true, add certain additional blocks to the return: user, userVisited, notes, seasons separated by a comma (optional))

• get-shows-genres [GET /shows/genres]: Display the list of available series genres. Params: no parameters

• get-shows-list [GET /shows/list]: Display the list of all series. Params: order? (Specify return order: alphabetical, popularity, followers (optional)), since? (Display only series modified since this date (UNIX timestamp — optional)), recent? (Only series from the last two years), starting? (Display series starting with specified characters (optional)), start? (Starting number for series list (optional, default 0)), limit? (Limit number of series displayed (optional, default 100)), filter? (Display filter (optional, new=only series not in the account)), platforms? (IDs of SVOD/VOD platforms where series are available), country? (Country for SVOD/VOD platforms), summary? (Return only essential series info), broadcasted? (Return only already broadcasted series)

• get-shows-member [GET /shows/member]: Display the list of all series of the member. Params: id? (Member's ID (optional, default identified member)), order? (Specify return order: alphabetical, progression, remaining_time, remaining_episodes, last_seen, last_added, rating, avg_rating, custom, next_date (optional, default alphabetical)), limit? (Limit the number of series to display (optional, default 100, maximum 200)), offset? (Starting number for the series list (optional, default 0)), status? (Filter series by status: current, active, archived, archived_and_completed, archived_and_not_started, completed, active_and_completed, not_started, stopped (optional)), excluded_genres? (Exclude certain genres separated by a comma for the series return (optional)), excluded_networks? (Exclude certain networks separated by a comma for the series return (optional)), excluded_status? (Exclude certain statuses for the series return (optional)), tags? (Retrieve series with tags separated by a comma (optional)), excluded_tags? (Exclude series with tags separated by a comma (optional)), summary? (Return only essential series info), includes? (If summary = true, add certain additional blocks to the return: user, userVisited, notes, platforms, seasons separated by a comma (optional)), platforms? (List of platform IDs where series must be available (Optional))

• get-shows-pictures [GET /shows/pictures]: Retrieve images of the series. Params: id? (Series ID (Optional if thetvdb_id specified)), thetvdb_id? (Series ID on TheTVDB (Optional if id specified)), order? (Specify return order: -date (date DESC), date (date ASC) (optional, default sort by id ASC)), start? (Starting number for the image list (optional, default 0)), limit? (Limit the number of images to display (optional, default all)), format? (Image display format: hd or all (optional, default all))

• get-shows-random [GET /shows/random]: Display a random series. Params: nb? (Number of series to display, default 1), summary? (Return only essential series info)

• get-shows-recommendations [GET /shows/recommendations]: Retrieve recommendations received by the identified user. Params: no parameters

• get-shows-search [GET /shows/search]: Search for a series, with member information if a token is provided. Params: title? (Searched title), summary? (Return only essential series info), order? (Return order (title|popularity|followers), default title), recent? (Only series from the last two years), platforms? (IDs of SVOD/VOD platforms where series are available), country? (Country for SVOD/VOD platforms), nbpp? (Number of results per page, default 5, maximum 100), page? (Page number, default 1)

• get-shows-seasons [GET /shows/seasons]: Display the seasons of the series. Params: id? (Series ID (Optional if thetvdb_id specified)), thetvdb_id? (Series ID on TheTVDB (Optional if id specified))

• get-shows-similars [GET /shows/similars]: Retrieve series marked as similar. Params: id? (Series ID (Optional if thetvdb_id specified)), thetvdb_id? (Series ID on TheTVDB (Optional if id specified)), details? (Return series details)

• get-shows-unrated [GET /shows/unrated]: Retrieve the list of finished and unrated series. Params: nbpp? (Number of results per page, default 20), page? (Page number, default 1), date? (Time limit, month for series ended in the last 30 days, all for all finished series (Optional, default month))

• get-shows-videos [GET /shows/videos]: Retrieve videos associated with the series. Params: id? (Series ID (Optional if thetvdb_id specified)), thetvdb_id? (Series ID on TheTVDB (Optional if id specified)), order? (Specify return order: -date (add date DESC), date (add date ASC) (optional, default sort by season/episode)), start? (Starting number for the video list (optional, default 0)), limit? (Limit the number of videos to display (optional, default all))

• post-shows-archive [POST /shows/archive]: Archive a series in the member's account. Params: id? (ID of the series (Optional if thetvdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id specified))

• post-shows-favorite [POST /shows/favorite]: Add a favorite series to the profile of the identified member. Params: id? (ID of the series to add.)

• post-shows-note [POST /shows/note]: Rate a series. Params: id? (ID of the series (Optional if thetvdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id specified)), note (Rating assigned from 1 to 5)

• post-shows-recommendation [POST /shows/recommendation]: Create a series recommendation from a member to a friend. Params: id? (ID of the series (Optional if thetvdb_id specified)), thetvdb_id? (ID of the series on TheTVDB (Optional if id specified)), to? (Friend's member ID), comments? (Comments for the friend (Optional))

• post-shows-rewatch [POST /shows/rewatch]: Rewatch an entire show. Params: id? (Series ID.)

• post-shows-show [POST /shows/show]: Add a series to the member's account. Params: id? (Series ID. You can include multiple by separating them with a comma (Optional if thetvdb_id or imdb_id specified)), thetvdb_id? (Series ID on TheTVDB. You can include multiple by separating them with a comma (Optional if id or imdb_id specified)), imdb_id? (Series ID on IMDB. You can include multiple by separating them with a comma (Optional if id or thetvdb_id specified)), episode_id? (ID of the last watched episode. If multiple series, the order of episodes must be exactly the same (Optional))

• post-shows-tags [POST /shows/tags]: Update tags for the given series of the identified member. Params: id? (ID of the series to tag.), tags? (Series tags: Words separated by a comma.)

• post-shows-watch [POST /shows/watch]: Bulk watch an entire show. Params: id? (Series ID.), note? (Rating assigned from 1 to 5 (optional))

• put-shows-recommendation [PUT /shows/recommendation]: Change the status of a received series recommendation. Params: id? (Recommendation ID), status? (Status (accept or decline))