Plex-Meta-Manager/docs/metadata/builders/myanimelist.md
2022-03-08 03:06:22 -05:00

19 KiB

MyAnimeList Builders

You can find anime using the features of MyAnimeList.net (MyAnimeList).

Configuring MyAnimeList in the config is required for any of these builders.

Attribute Description Works with Movies Works with Shows Works with Playlists and Custom Sort
mal_all Finds every anime in MyAnimeList's Top All Anime list
mal_airing Finds every anime in MyAnimeList's Top Airing Anime list
mal_upcoming Finds every anime in MyAnimeList's Top Upcoming Anime list
mal_tv Finds every anime in MyAnimeList's Top Anime TV Series list
mal_movie Finds every anime in MyAnimeList's Top Anime Movies list
mal_ova Finds every anime in MyAnimeList's Top Anime OVA Series list
mal_special Finds every anime in MyAnimeList's Top Anime Specials list
mal_popular Finds every anime in MyAnimeList's Most Popular Anime list
mal_favorite Finds every anime in MyAnimeList's Most Favorited Anime list
mal_suggested Finds the suggested anime in by MyAnimeList for the authorized user
mal_id Finds the anime specified by the MyAnimeList ID
mal_userlist Finds anime in MyAnimeList User's Anime list the options are detailed below
mal_season Finds anime in MyAnimeList's Seasonal Anime list the options are detailed below
mal_genre Finds every anime tagged with the specified genre id. Genre options can be found on MyAnimeList's Search
mal_studio Finds every anime tagged with the specified studio/producer/licensor id. Studio options can be found on MyAnimeList's Search

Expected Input

The builders below are expected to have a single integer value of how many movies/shows to query.

The attributes of MyAnimeList ID, MyAnimeList Seasonal Anime, MyAnimeList User Anime List, MyAnimeList Genre, and MyAnimeList Studio are detailed in their sections below.

MyAnimeList Top All Anime

Gets every anime in MyAnimeList's Top Airing Anime list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top All Anime:
    mal_all: 30
    collection_order: custom
    sync_mode: sync

MyAnimeList Top Airing Anime

Gets every anime in MyAnimeList's Top Airing Anime list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Airing Anime:
    mal_airing: 10
    collection_order: custom
    sync_mode: sync

MyAnimeList Top Upcoming Anime

Gets every anime in MyAnimeList's Top Upcoming Anime list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Upcoming Anime:
    mal_upcoming: 10
    collection_order: custom
    sync_mode: sync

MyAnimeList Top Anime TV Series

Gets every anime in MyAnimeList's Top Anime TV Series list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Anime TV Series:
    mal_tv: 20
    collection_order: custom
    sync_mode: sync

MyAnimeList Top Anime Movies

Gets every anime in MyAnimeList's Top Anime Movies list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Anime Movies:
    mal_movie: 20
    collection_order: custom
    sync_mode: sync

MyAnimeList Top Anime OVA Series

Gets every anime in MyAnimeList's Top Anime OVA Series list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Anime OVA Series:
    mal_ova: 20
    collection_order: custom
    sync_mode: sync

MyAnimeList Top Anime Specials

Gets every anime in MyAnimeList's Top Anime Specials list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Anime Specials:
    mal_special: 20
    collection_order: custom
    sync_mode: sync

Gets every anime in MyAnimeList's Most Popular Anime list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Most Popular Anime:
    mal_popular: 20
    collection_order: custom
    sync_mode: sync

MyAnimeList Most Favorited Anime

Gets every anime in MyAnimeList's Most Favorited Anime list. (Maximum: 500)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Most Favorited Anime:
    mal_favorite: 20
    collection_order: custom
    sync_mode: sync

MyAnimeList Suggested Anime

Gets the suggested anime in by MyAnimeList for the authorized user. (Maximum: 100)

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Suggested Anime:
    mal_suggested: 20
    collection_order: custom
    sync_mode: sync

MyAnimeList ID

Gets the anime specified by the MyAnimeList ID.

The expected input is a MyAnimeList ID. Multiple values are supported as either a list or a comma-separated string.

collections:
  Cowboy Bebop:
    mal_id: 23, 219

MyAnimeList User Anime List

Gets anime in MyAnimeList User's Anime list. The different sub-attributes are detailed below. The only required attribute is username

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

Attribute Description
username Description: A user's MyAnimeList Username or @me for the authorized user
status Description: Status to search for
Default: all
Values:
allAll Anime List
watchingCurrently Watching List
completedCompleted List
on_holdOn Hold List
droppedDropped List
plan_to_watchPlan to Watch
sort_by Description: Sort Order to return
Default: score
Values:
scoreSort by Score
last_updatedSort by Last Updated
titleSort by Anime Title
start_dateSort by Start Date
limit Description: Don't return more then this number
Default: 100
Values: Number of Anime to query from MyAnimeList (max: 1000)
collections:
  Currently Watching Anime:
    mal_userlist:
      username: "@me"
      status: watching
      sort_by: score
      limit: 500
    collection_order: custom
    sync_mode: sync

MyAnimeList Seasonal Anime

Gets anime in MyAnimeList's Seasonal Anime list the options are detailed below.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

Attribute Description & Values
season Description: Season to search
Default: current
Values:
winterFor winter season January, February, March
springFor spring season April, May, June
summerFor summer season July, August, September
fallFor fall season October, November, December
currentFor the current Season
year Description: Year to search
Default: Current Year
Values: Number between 1917 and the current year.
sort_by Description: Sort Order
Default: members
Values:
membersSort by Most Members
scoreSort by Score
limit Description: Don't return more then this number
Default: 100
Values: Number of Anime to query from MyAnimeList (max: 500)
collections:
  Current Anime Season:
    mal_season:
      sort_by: members
      limit: 50
    collection_order: custom
    sync_mode: sync
collections:
  Fall 2020 Anime:
    mal_season:
      season: fall
      year: 2020
      limit: 50
    collection_order: custom
    sync_mode: sync

MyAnimeList Genre

Gets every anime tagged with the specified genre ID sorted by members the options are detailed below. genre_id is the only required attribute.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

  • Genre options can be found on MyAnimeList's Search Page.
  • To find the ID click on a Genre in the link above and there should be a number in the URL that's the genre_id.
  • For example if the url is https://myanimelist.net/anime/genre/1/Action the genre_id would be 1.
Attribute Description
genre_id The ID of Genre from MyAnimeList
limit Number of Anime to query from MyAnimeList
Default: 0 (All)
collections:
  Sports Anime:
    mal_genre:
      genre_id: 30
    collection_order: custom
    sync_mode: sync

MyAnimeList Studio

Gets every anime tagged with the specified studio/producer/licensor ID sorted by members the options are detailed below. studio_id is the only required attribute.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

  • Studio options can be found on MyAnimeList's Search Page.
  • To find the ID click on a Studio in the link above and there should be a number in the URL that's the studio_id.
  • For example if the url is https://myanimelist.net/anime/producer/4/Bones the studio_id would be 4.
Attribute Description
studio_id The ID of Studio/Producer/Licensor from MyAnimeList
limit Number of Anime to query from MyAnimeList
Default: 0 (All)
collections:
  Bones Studio Anime:
    mal_studio:
      studio_id: 4
    collection_order: custom
    sync_mode: sync