AniList(api_url: str = 'https://graphql.anilist.co', client: Client | None = None)
+AniList API client.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ api_url
+ |
+
+ str
+ |
+
+
+
+ The URL of the AniList API. + |
+
+ 'https://graphql.anilist.co'
+ |
+
+ client
+ |
+
+ Client | None
+ |
+
+
+
+ An |
+
+ None
+ |
+
src/pyanilist/_client.pyget_airing_schedule(media: int | str | Media, not_yet_aired: bool | None = None) -> Iterator[AiringSchedule]
+Retrieve the airing schedule for a given Media object or ID.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ media
+ |
+
+ int | str | Media
+ |
+
+
+
+ The media to get the airing schedule for. Can be an ID ( |
+ + required + | +
+ not_yet_aired
+ |
+
+ bool | None
+ |
+
+
+
+ Filter results to only include episodes that have not yet aired ( |
+
+ None
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ AiringSchedule
+ |
+
+
+
+
+ |
+
src/pyanilist/_client.pyget_characters(media: int | str | Media, sort: Iterable[CharacterSort] | CharacterSort | None = None, role: CharacterRole | None = None) -> Iterator[Character]
+Retrieve characters associated with a given Media object or ID.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ media
+ |
+
+ int | str | Media
+ |
+
+
+
+ The media to get characters for. Can be an ID ( |
+ + required + | +
+ sort
+ |
+
+ Iterable[CharacterSort] | CharacterSort | None
+ |
+
+
+
+ Sorting criteria for the characters. + |
+
+ None
+ |
+
+ role
+ |
+
+ CharacterRole | None
+ |
+
+
+
+ Filter characters by their role in the media. If |
+
+ None
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ Character
+ |
+
+
+
+
+ |
+
src/pyanilist/_client.pyget_media(search: str | None = None, *, id: int | None = None, id_mal: int | None = None, start_date: int | None = None, end_date: int | None = None, season: MediaSeason | None = None, season_year: int | None = None, type: MediaType | None = None, format: MediaFormat | None = None, status: MediaStatus | None = None, episodes: int | None = None, chapters: int | None = None, duration: int | None = None, volumes: int | None = None, is_adult: bool | None = None, genre: str | None = None, tag: str | None = None, minimum_tag_rank: int | None = None, tag_category: str | None = None, licensed_by: str | None = None, licensed_by_id: int | None = None, average_score: int | None = None, popularity: int | None = None, source: MediaSource | None = None, country_of_origin: str | None = None, is_licensed: bool | None = None, id_not: int | None = None, id_in: Iterable[int] | None = None, id_not_in: Iterable[int] | None = None, id_mal_not: int | None = None, id_mal_in: Iterable[int] | None = None, id_mal_not_in: Iterable[int] | None = None, start_date_greater: int | None = None, start_date_lesser: int | None = None, start_date_like: str | None = None, end_date_greater: int | None = None, end_date_lesser: int | None = None, end_date_like: str | None = None, format_in: Iterable[MediaFormat] | None = None, format_not: MediaFormat | None = None, format_not_in: Iterable[MediaFormat] | None = None, status_in: Iterable[MediaStatus] | None = None, status_not: MediaStatus | None = None, status_not_in: Iterable[MediaStatus] | None = None, episodes_greater: int | None = None, episodes_lesser: int | None = None, duration_greater: int | None = None, duration_lesser: int | None = None, chapters_greater: int | None = None, chapters_lesser: int | None = None, volumes_greater: int | None = None, volumes_lesser: int | None = None, genre_in: Iterable[str] | None = None, genre_not_in: Iterable[str] | None = None, tag_in: Iterable[str] | None = None, tag_not_in: Iterable[str] | None = None, tag_category_in: Iterable[str] | None = None, tag_category_not_in: Iterable[str] | None = None, licensed_by_in: Iterable[str] | None = None, licensed_by_id_in: Iterable[int] | None = None, average_score_not: int | None = None, average_score_greater: int | None = None, average_score_lesser: int | None = None, popularity_not: int | None = None, popularity_greater: int | None = None, popularity_lesser: int | None = None, source_in: Iterable[MediaSource] | None = None, sort: Iterable[MediaSort] | None = None) -> Media
+Search for media on AniList based on the provided parameters.
+ + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ search
+ |
+
+ str | None
+ |
+
+
+
+ Filter by search query. + |
+
+ None
+ |
+
+ id
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media id. + |
+
+ None
+ |
+
+ id_mal
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's MyAnimeList id. + |
+
+ None
+ |
+
+ start_date
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the start date of the media. +Must be an 8 digit long date integer (YYYYMMDD). +Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500. + |
+
+ None
+ |
+
+ end_date
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the end date of the media. + |
+
+ None
+ |
+
+ season
+ |
+
+ MediaSeason | None
+ |
+
+
+
+ Filter by the season the media was released in. + |
+
+ None
+ |
+
+ season_year
+ |
+
+ int | None
+ |
+
+
+
+ The year of the season (Winter 2017 would also include December 2016 releases). Requires season argument. + |
+
+ None
+ |
+
+ type
+ |
+
+ MediaType | None
+ |
+
+
+
+ Filter by the media's type. + |
+
+ None
+ |
+
+ format
+ |
+
+ MediaFormat | None
+ |
+
+
+
+ Filter by the media's format. + |
+
+ None
+ |
+
+ status
+ |
+
+ MediaStatus | None
+ |
+
+
+
+ Filter by the media's current release status. + |
+
+ None
+ |
+
+ episodes
+ |
+
+ int | None
+ |
+
+
+
+ Filter by amount of episodes the media has. + |
+
+ None
+ |
+
+ chapters
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's episode length. + |
+
+ None
+ |
+
+ duration
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's chapter count. + |
+
+ None
+ |
+
+ volumes
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's volume count. + |
+
+ None
+ |
+
+ is_adult
+ |
+
+ bool | None
+ |
+
+
+
+ Filter by if the media's intended for 18+ adult audiences. + |
+
+ None
+ |
+
+ genre
+ |
+
+ str | None
+ |
+
+
+
+ Filter by the media's genres. + |
+
+ None
+ |
+
+ tag
+ |
+
+ str | None
+ |
+
+
+
+ Filter by the media's tags. + |
+
+ None
+ |
+
+ minimum_tag_rank
+ |
+
+ int | None
+ |
+
+
+
+ Only apply the tags filter argument to tags above this rank. Default: 18. + |
+
+ None
+ |
+
+ tag_category
+ |
+
+ str | None
+ |
+
+
+
+ Filter by the media's tags within a tag category. + |
+
+ None
+ |
+
+ licensed_by
+ |
+
+ str | None
+ |
+
+
+
+ Filter media by sites name with a online streaming or reading license. + |
+
+ None
+ |
+
+ licensed_by_id
+ |
+
+ int | None
+ |
+
+
+
+ Filter media by sites id with a online streaming or reading license. + |
+
+ None
+ |
+
+ average_score
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's average score. + |
+
+ None
+ |
+
+ popularity
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the number of users with this media on their list. + |
+
+ None
+ |
+
+ source
+ |
+
+ MediaSource | None
+ |
+
+
+
+ Filter by the source type of the media. + |
+
+ None
+ |
+
+ country_of_origin
+ |
+
+ str | None
+ |
+
+
+
+ Filter by the media's country of origin. + |
+
+ None
+ |
+
+ is_licensed
+ |
+
+ bool | None
+ |
+
+
+
+ If the media is officially licensed or a self-published doujin release. + |
+
+ None
+ |
+
+ id_not
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media id. + |
+
+ None
+ |
+
+ id_in
+ |
+
+ Iterable[int] | None
+ |
+
+
+
+ Filter by the media id. + |
+
+ None
+ |
+
+ id_not_in
+ |
+
+ Iterable[int] | None
+ |
+
+
+
+ Filter by the media id. + |
+
+ None
+ |
+
+ id_mal_not
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's MyAnimeList id. + |
+
+ None
+ |
+
+ id_mal_in
+ |
+
+ Iterable[int] | None
+ |
+
+
+
+ Filter by the media's MyAnimeList id. + |
+
+ None
+ |
+
+ id_mal_not_in
+ |
+
+ Iterable[int] | None
+ |
+
+
+
+ Filter by the media's MyAnimeList id. + |
+
+ None
+ |
+
+ start_date_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the start date of the media. +Must be an 8 digit long date integer (YYYYMMDD). +Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500. + |
+
+ None
+ |
+
+ start_date_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the start date of the media. +Must be an 8 digit long date integer (YYYYMMDD). +Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500. + |
+
+ None
+ |
+
+ start_date_like
+ |
+
+ str | None
+ |
+
+
+
+ Filter by the start date of the media. + |
+
+ None
+ |
+
+ end_date_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the end date of the media. +Must be an 8 digit long date integer (YYYYMMDD). +Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500. + |
+
+ None
+ |
+
+ end_date_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the end date of the media. +Must be an 8 digit long date integer (YYYYMMDD). +Unknown dates represented by 0. E.g. 2016: 20160000, May 1976: 19760500. + |
+
+ None
+ |
+
+ end_date_like
+ |
+
+ str | None
+ |
+
+
+
+ Filter by the end date of the media. + |
+
+ None
+ |
+
+ format_in
+ |
+
+ Iterable[MediaFormat] | None
+ |
+
+
+
+ Filter by the media's format. + |
+
+ None
+ |
+
+ format_not
+ |
+
+ MediaFormat | None
+ |
+
+
+
+ Filter by the media's format. + |
+
+ None
+ |
+
+ format_not_in
+ |
+
+ Iterable[MediaFormat] | None
+ |
+
+
+
+ Filter by the media's format. + |
+
+ None
+ |
+
+ status_in
+ |
+
+ Iterable[MediaStatus] | None
+ |
+
+
+
+ Filter by the media's current release status. + |
+
+ None
+ |
+
+ status_not
+ |
+
+ MediaStatus | None
+ |
+
+
+
+ Filter by the media's current release status. + |
+
+ None
+ |
+
+ status_not_in
+ |
+
+ Iterable[MediaStatus] | None
+ |
+
+
+
+ Filter by the media's current release status. + |
+
+ None
+ |
+
+ episodes_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by amount of episodes the media has. + |
+
+ None
+ |
+
+ episodes_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by amount of episodes the media has. + |
+
+ None
+ |
+
+ duration_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's episode length. + |
+
+ None
+ |
+
+ duration_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's episode length. + |
+
+ None
+ |
+
+ chapters_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's chapter count. + |
+
+ None
+ |
+
+ chapters_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's chapter count. + |
+
+ None
+ |
+
+ volumes_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's volume count. + |
+
+ None
+ |
+
+ volumes_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's volume count. + |
+
+ None
+ |
+
+ genre_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter by the media's genres. + |
+
+ None
+ |
+
+ genre_not_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter by the media's genres. + |
+
+ None
+ |
+
+ tag_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter by the media's tags. + |
+
+ None
+ |
+
+ tag_not_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter by the media's tags. + |
+
+ None
+ |
+
+ tag_category_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter by the media's tags within a tag category. + |
+
+ None
+ |
+
+ tag_category_not_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter by the media's tags within a tag category. + |
+
+ None
+ |
+
+ licensed_by_in
+ |
+
+ Iterable[str] | None
+ |
+
+
+
+ Filter media by sites name with a online streaming or reading license. + |
+
+ None
+ |
+
+ licensed_by_id_in
+ |
+
+ Iterable[int] | None
+ |
+
+
+
+ Filter media by sites id with a online streaming or reading license. + |
+
+ None
+ |
+
+ average_score_not
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's average score. + |
+
+ None
+ |
+
+ average_score_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's average score. + |
+
+ None
+ |
+
+ average_score_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the media's average score. + |
+
+ None
+ |
+
+ popularity_not
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the number of users with this media on their list. + |
+
+ None
+ |
+
+ popularity_greater
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the number of users with this media on their list. + |
+
+ None
+ |
+
+ popularity_lesser
+ |
+
+ int | None
+ |
+
+
+
+ Filter by the number of users with this media on their list. + |
+
+ None
+ |
+
+ source_in
+ |
+
+ Iterable[MediaSource] | None
+ |
+
+
+
+ Filter by the source type of the media. + |
+
+ None
+ |
+
+ sort
+ |
+
+ Iterable[MediaSort] | None
+ |
+
+
+
+ The order the results will be returned in. + |
+
+ None
+ |
+
Raises:
+| Type | +Description | +
|---|---|
+ HTTPStatusError
+ |
+
+
+
+ AniList returned a non 2xx response. + |
+
Returns:
+| Type | +Description | +
|---|---|
+ Media
+ |
+
+
+
+ A Media object representing the retrieved media information. + |
+
src/pyanilist/_client.py71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297 +298 +299 +300 +301 +302 +303 +304 +305 +306 +307 +308 +309 +310 +311 +312 +313 +314 +315 | |
get_recommendations(media: int | str | Media, sort: Iterable[RecommendationSort] | RecommendationSort | None = None) -> Iterator[Media]
+Retrieve recommended media based on a given Media object or ID.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ media
+ |
+
+ int | str | Media
+ |
+
+
+
+ The media to get recommendations for. Can be an ID ( |
+ + required + | +
+ sort
+ |
+
+ Iterable[RecommendationSort] | RecommendationSort | None
+ |
+
+
+
+ Sorting criteria for the recommendations. + |
+
+ None
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ Media
+ |
+
+
+
+
+ |
+
src/pyanilist/_client.pyget_relations(media: int | str | Media) -> Iterator[RelatedMedia]
+Retrieve related media based on a given Media object or ID.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ media
+ |
+
+ int | str | Media
+ |
+
+
+
+ The media to get relations for. Can be an ID ( |
+ + required + | +
Yields:
+| Type | +Description | +
|---|---|
+ RelatedMedia
+ |
+
+
+
+
+ |
+
src/pyanilist/_client.pyget_staffs(media: int | str | Media, sort: Iterable[StaffSort] | StaffSort | None = None) -> Iterator[Staff]
+Retrieve staffs based on a given Media object or ID.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ media
+ |
+
+ int | str | Media
+ |
+
+
+
+ The media to get staffs for. Can be an ID ( |
+ + required + | +
+ sort
+ |
+
+ Iterable[StaffSort] | StaffSort | None
+ |
+
+
+
+ Sorting criteria for the staffs. + |
+
+ None
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ Staff
+ |
+
+
+
+
+ |
+
src/pyanilist/_client.pyget_studios(media: int | str | Media, sort: Iterable[StudioSort] | StudioSort | None = None, is_main: bool | None = None) -> Iterator[Studio]
+Retrieve studios based on a given Media object or ID.
Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
+ media
+ |
+
+ int | str | Media
+ |
+
+
+
+ The media to get studios for. Can be an ID ( |
+ + required + | +
+ sort
+ |
+
+ Iterable[StudioSort] | StudioSort | None
+ |
+
+
+
+ Sorting criteria for the studios. + |
+
+ None
+ |
+
+ is_main
+ |
+
+ bool | None
+ |
+
+
+
+ Filter for the main studios ( |
+
+ None
+ |
+
Yields:
+| Type | +Description | +
|---|---|
+ Studio
+ |
+
+
+
+
+ |
+
src/pyanilist/_client.py
+ Bases: BaseStrEnum
The role the character plays in the media.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+A background character in the media.
+class-attribute
+ instance-attribute
+
+
+A primary character role in the media.
+
+ Bases: BaseStrEnum
Character sort enums.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+
+ Bases: BaseStrEnum
External Link Type.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Informational site.
+class-attribute
+ instance-attribute
+
+
+Social media site.
+
+ Bases: BaseStrEnum
The format the media was released in.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Professionally published manga with more than one chapter.
+class-attribute
+ instance-attribute
+
+
+Anime movies with a theatrical release.
+class-attribute
+ instance-attribute
+
+
+Short anime released as a music video.
+class-attribute
+ instance-attribute
+
+
+Written books released as a series of light novels.
+class-attribute
+ instance-attribute
+
+
+Original Net Animation. +Anime that have been originally released online or are only available through streaming services.
+class-attribute
+ instance-attribute
+
+
+Manga with just one chapter.
+class-attribute
+ instance-attribute
+
+
+Original Video Animation. +Anime that have been released directly on DVD/Blu-ray without +originally going through a theatrical release or television broadcast.
+class-attribute
+ instance-attribute
+
+
+Special episodes that have been included in DVD/Blu-ray releases, picture dramas, pilots, etc.
+class-attribute
+ instance-attribute
+
+
+Anime broadcast on television.
+
+ Bases: BaseStrEnum
The type of ranking.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Ranking is based on the media's popularity.
+
+ Bases: BaseStrEnum
Type of relation media has to its parent.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+An adaptation of this media into a different format.
+class-attribute
+ instance-attribute
+
+
+An alternative version of the same media.
+class-attribute
+ instance-attribute
+
+
+Shares at least 1 character.
+class-attribute
+ instance-attribute
+
+
+Version 2 only.
+class-attribute
+ instance-attribute
+
+
+Version 2 only.
+class-attribute
+ instance-attribute
+
+
+Other.
+class-attribute
+ instance-attribute
+
+
+The media a side story is from.
+class-attribute
+ instance-attribute
+
+
+Released before the relation.
+class-attribute
+ instance-attribute
+
+
+Released after the relation.
+class-attribute
+ instance-attribute
+
+
+A side story of the parent media.
+class-attribute
+ instance-attribute
+
+
+Version 2 only. The source material the media was adapted from.
+class-attribute
+ instance-attribute
+
+
+An alternative version of the media with a different primary focus.
+
+ Bases: BaseStrEnum
The season the media was initially released in.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Months September to November.
+class-attribute
+ instance-attribute
+
+
+Months March to May.
+class-attribute
+ instance-attribute
+
+
+Months June to August.
+
+ Bases: BaseStrEnum
Media sort enums.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+
+ Bases: BaseStrEnum
Source type the media was adapted from.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Version 2+ only. Japanese Anime.
+class-attribute
+ instance-attribute
+
+
+Version 3 only. Comics excluding manga.
+class-attribute
+ instance-attribute
+
+
+Version 2+ only. Self-published works.
+class-attribute
+ instance-attribute
+
+
+Version 3 only. Games excluding video games.
+class-attribute
+ instance-attribute
+
+
+Written work published in volumes.
+class-attribute
+ instance-attribute
+
+
+Version 3 only. Live action media such as movies or TV show.
+class-attribute
+ instance-attribute
+
+
+Asian comic book.
+class-attribute
+ instance-attribute
+
+
+Version 3 only. Multimedia project.
+class-attribute
+ instance-attribute
+
+
+Version 2+ only. Written works not published in volumes.
+class-attribute
+ instance-attribute
+
+
+An original production not based of another work.
+class-attribute
+ instance-attribute
+
+
+Other.
+class-attribute
+ instance-attribute
+
+
+Version 3 only. Picture book.
+class-attribute
+ instance-attribute
+
+
+Video game.
+class-attribute
+ instance-attribute
+
+
+Video game driven primary by text and narrative.
+
+ Bases: BaseStrEnum
The current releasing status of the media.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Ended before the work could be finished.
+class-attribute
+ instance-attribute
+
+
+Has completed and is no longer being released.
+class-attribute
+ instance-attribute
+
+
+Version 2 only. Is currently paused from releasing and will resume at a later date.
+class-attribute
+ instance-attribute
+
+
+To be released at a later date.
+
+ Bases: BaseStrEnum
The type of the media; anime or manga.
+ + + + + + + + + + + +
+ Bases: BaseStrEnum
Recommendation sort enums.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+
+ Bases: BaseStrEnum
Staff sort enums.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+
+ Bases: BaseStrEnum
Studio sort enums.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+class-attribute
+ instance-attribute
+
+
+
+ Bases: ParentModel
Media Airing Schedule.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+The time the episode airs at.
+class-attribute
+ instance-attribute
+
+
+episode: int | None = None
+The airing episode number.
+class-attribute
+ instance-attribute
+
+
+id: int | None = None
+The id of the airing schedule item.
+class-attribute
+ instance-attribute
+
+
+time_until_airing: timedelta | None = None
+The time delta until the episode starts airing.
+
+ Bases: ParentModel
A character that features in an anime or manga.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+age: str | None = None
+The character's age. Note this is a string, not an int, it may contain further text and additional ages.
+class-attribute
+ instance-attribute
+
+
+blood_type: str | None = None
+The character's blood type.
+class-attribute
+ instance-attribute
+
+
+The character's birth date.
+class-attribute
+ instance-attribute
+
+
+description: str | None = None
+A general description of the character.
+class-attribute
+ instance-attribute
+
+
+favourites: int | None = None
+The amount of user's who have favourited the character.
+class-attribute
+ instance-attribute
+
+
+gender: str | None = None
+The character's gender. Usually Male, Female, or Non-binary but can be any string.
+class-attribute
+ instance-attribute
+
+
+image: CharacterImage = CharacterImage()
+Character images.
+class-attribute
+ instance-attribute
+
+
+name: CharacterName = CharacterName()
+The names of the character.
+class-attribute
+ instance-attribute
+
+
+role: CharacterRole | None = None
+The character's role in the media.
+class-attribute
+ instance-attribute
+
+
+site_url: HttpUrl | None = None
+The url for the character page on the AniList website.
+
+ Bases: ParentModel
Character's image.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+large: HttpUrl | None = None
+The character's image of media at its largest size.
+class-attribute
+ instance-attribute
+
+
+medium: HttpUrl | None = None
+The character's image of media at medium size.
+
+ Bases: ParentModel
The names of the character.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Other names the character might be referred to as.
+class-attribute
+ instance-attribute
+
+
+Other names the character might be referred to as but are spoilers.
+class-attribute
+ instance-attribute
+
+
+first: str | None = None
+The character's given name.
+class-attribute
+ instance-attribute
+
+
+full: str | None = None
+The character's first and last name.
+class-attribute
+ instance-attribute
+
+
+last: str | None = None
+The character's surname.
+class-attribute
+ instance-attribute
+
+
+middle: str | None = None
+The character's middle name.
+class-attribute
+ instance-attribute
+
+
+native: str | None = None
+The character's full name in their native language.
+
+ Bases: ParentModel
Naive date object that allows for incomplete date values (fuzzy).
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+day: int | None = None
+Numeric Day (24).
+class-attribute
+ instance-attribute
+
+
+month: int | None = None
+Numeric Month (3).
+class-attribute
+ instance-attribute
+
+
+year: int | None = None
+Numeric Year (2017).
+iso_format() -> str
+Return the date formatted as an ISO 8601 string.
+If year, month, and day are available, the format is "YYYY-MM-DD". +If only year and month are available, the format is "YYYY-MM". +If only year is available, the format is "YYYY". +If no information is available, an empty string is returned.
+ +src/pyanilist/_models.pyto_int() -> int
+Return an 8 digit long date integer (YYYYMMDD). +Unknown dates represented by 0. +For example, 2016 is 20160000 and May 1976 is 19760500.
+ +src/pyanilist/_models.py
+ Bases: ParentModel
Anime or Manga.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+average_score: int | None = None
+A weighted average score of all the user's scores of the media.
+class-attribute
+ instance-attribute
+
+
+banner_image: HttpUrl | None = None
+The banner image of the media.
+class-attribute
+ instance-attribute
+
+
+chapters: int | None = None
+The amount of chapters the manga has when complete.
+class-attribute
+ instance-attribute
+
+
+country_of_origin: CountryAlpha2 | None = None
+Where the media was created. (ISO 3166-1 alpha-2).
+class-attribute
+ instance-attribute
+
+
+cover_image: MediaCoverImage = MediaCoverImage()
+The cover images of the media.
+class-attribute
+ instance-attribute
+
+
+description: str | None = None
+Short description of the media's story and characters.
+class-attribute
+ instance-attribute
+
+
+duration: int | None = None
+The general length of each anime episode in minutes.
+class-attribute
+ instance-attribute
+
+
+The last official release date of the media.
+class-attribute
+ instance-attribute
+
+
+episodes: int | None = None
+The amount of episodes the anime has when complete.
+class-attribute
+ instance-attribute
+
+
+external_links: tuple[MediaExternalLink, ...] = tuple()
+External links to another site related to the media.
+class-attribute
+ instance-attribute
+
+
+favourites: int | None = None
+The amount of user's who have favourited the media.
+class-attribute
+ instance-attribute
+
+
+format: MediaFormat | None = None
+The format the media was released in.
+class-attribute
+ instance-attribute
+
+
+The genres of the media.
+class-attribute
+ instance-attribute
+
+
+hashtag: str | None = None
+Official Twitter hashtags for the media.
+class-attribute
+ instance-attribute
+
+
+id_mal: int | None = None
+The mal id of the media.
+class-attribute
+ instance-attribute
+
+
+is_adult: bool | None = None
+If the media is intended only for 18+ adult audiences.
+class-attribute
+ instance-attribute
+
+
+is_licensed: bool | None = None
+If the media is officially licensed or a self-published doujin release.
+class-attribute
+ instance-attribute
+
+
+is_locked: bool | None = None
+Locked media may not be added to lists our favorited. This may be due to the entry pending for deletion or other reasons.
+class-attribute
+ instance-attribute
+
+
+mean_score: int | None = None
+Mean score of all the user's scores of the media.
+class-attribute
+ instance-attribute
+
+
+next_airing_episode: AiringSchedule = AiringSchedule()
+The media's next episode airing schedule.
+class-attribute
+ instance-attribute
+
+
+popularity: int | None = None
+The number of users with the media on their list.
+class-attribute
+ instance-attribute
+
+
+The ranking of the media in a particular time span and format compared to other media.
+class-attribute
+ instance-attribute
+
+
+season: MediaSeason | None = None
+The season the media was initially released in.
+class-attribute
+ instance-attribute
+
+
+season_year: int | None = None
+The season year the media was initially released in.
+instance-attribute
+
+
+site_url: HttpUrl
+The url for the media page on the AniList website.
+class-attribute
+ instance-attribute
+
+
+source: MediaSource | None = None
+Source type the media was adapted from.
+class-attribute
+ instance-attribute
+
+
+The first official release date of the media.
+class-attribute
+ instance-attribute
+
+
+status: MediaStatus | None = None
+The current releasing status of the media.
+class-attribute
+ instance-attribute
+
+
+streaming_episodes: tuple[MediaStreamingEpisode, ...] = tuple()
+Data and links to legal streaming episodes on external sites.
+class-attribute
+ instance-attribute
+
+
+Alternative titles of the media.
+class-attribute
+ instance-attribute
+
+
+List of tags that describes elements and themes of the media.
+class-attribute
+ instance-attribute
+
+
+title: MediaTitle = MediaTitle()
+The official titles of the media in various languages.
+class-attribute
+ instance-attribute
+
+
+trailer: MediaTrailer = MediaTrailer()
+Media trailer or advertisement.
+class-attribute
+ instance-attribute
+
+
+trending: int | None = None
+The amount of related activity in the past hour.
+class-attribute
+ instance-attribute
+
+
+type: MediaType | None = None
+The type of the media; anime or manga.
+class-attribute
+ instance-attribute
+
+
+When the media's data was last updated.
+class-attribute
+ instance-attribute
+
+
+volumes: int | None = None
+The amount of volumes the manga has when complete.
+
+ Bases: ParentModel
The cover images of the media.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+color: Color | None = None
+Average #hex color of cover image
+class-attribute
+ instance-attribute
+
+
+extra_large: HttpUrl | None = None
+The cover image url of the media at its largest size. If this size isn't available, large will be provided instead.
+class-attribute
+ instance-attribute
+
+
+large: HttpUrl | None = None
+The cover image url of the media at a large size
+class-attribute
+ instance-attribute
+
+
+medium: HttpUrl | None = None
+The cover image url of the media at medium size
+
+ Bases: ParentModel
An external link to another site related to the media or staff member.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+color: Color | None = None
+Average #hex color.
+class-attribute
+ instance-attribute
+
+
+icon: HttpUrl | None = None
+The icon image url of the site. Not available for all links. Transparent PNG 64x64.
+class-attribute
+ instance-attribute
+
+
+id: int | None = None
+The id of the external link.
+class-attribute
+ instance-attribute
+
+
+is_disabled: bool | None = None
+Indicates if the link is currently disabled.
+class-attribute
+ instance-attribute
+
+
+language: str | None = None
+Language the site content is in. See Staff language field for values.
+class-attribute
+ instance-attribute
+
+
+notes: str | None = None
+Additional notes about the link or its relevance.
+class-attribute
+ instance-attribute
+
+
+site: str | None = None
+The links website site name.
+class-attribute
+ instance-attribute
+
+
+site_id: int | None = None
+The links website site id.
+class-attribute
+ instance-attribute
+
+
+type: ExternalLinkType | None = None
+Type of the external link.
+class-attribute
+ instance-attribute
+
+
+url: HttpUrl | None = None
+The url of the external link or base url of link source.
+
+ Bases: ParentModel
The ranking of a media in a particular time span and format compared to other media.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+all_time: bool | None = None
+If the ranking is based on all time instead of a season/year.
+class-attribute
+ instance-attribute
+
+
+context: str | None = None
+String that gives context to the ranking type and time span.
+class-attribute
+ instance-attribute
+
+
+format: MediaFormat | None = None
+The format the media is ranked within.
+class-attribute
+ instance-attribute
+
+
+id: int | None = None
+The id of the rank.
+class-attribute
+ instance-attribute
+
+
+rank: int | None = None
+The numerical rank of the media.
+class-attribute
+ instance-attribute
+
+
+season: MediaSeason | None = None
+The season the media is ranked within.
+class-attribute
+ instance-attribute
+
+
+type: MediaRankType | None = None
+The type of ranking.
+class-attribute
+ instance-attribute
+
+
+year: int | None = None
+The year the media is ranked within.
+
+ Bases: ParentModel
Data and links to legal streaming episodes on external sites.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+site: str | None = None
+The site location of the streaming episodes.
+class-attribute
+ instance-attribute
+
+
+thumbnail: HttpUrl | None = None
+Url of episode image thumbnail.
+class-attribute
+ instance-attribute
+
+
+title: str | None = None
+Title of the episode.
+class-attribute
+ instance-attribute
+
+
+url: HttpUrl | None = None
+The url of the episode.
+
+ Bases: ParentModel
A tag that describes a theme or element of the media.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+category: str | None = None
+The categories of tags this tag belongs to.
+class-attribute
+ instance-attribute
+
+
+description: str | None = None
+A general description of the tag.
+class-attribute
+ instance-attribute
+
+
+id: int | None = None
+The id of the tag.
+class-attribute
+ instance-attribute
+
+
+is_adult: bool | None = None
+If the tag is only for adult 18+ media.
+class-attribute
+ instance-attribute
+
+
+is_general_spoiler: bool | None = None
+If the tag could be a spoiler for any media.
+class-attribute
+ instance-attribute
+
+
+is_media_spoiler: bool | None = None
+If the tag is a spoiler for this media.
+class-attribute
+ instance-attribute
+
+
+name: str | None = None
+The name of the tag.
+class-attribute
+ instance-attribute
+
+
+rank: int | None = None
+The relevance ranking of the tag out of the 100 for this media.
+class-attribute
+ instance-attribute
+
+
+user_id: int | None = None
+The user who submitted the tag.
+
+ Bases: ParentModel
The official titles of the media in various languages.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+english: str | None = None
+The official English title.
+class-attribute
+ instance-attribute
+
+
+native: str | None = None
+Official title in its native language.
+class-attribute
+ instance-attribute
+
+
+romaji: str | None = None
+The romanization of the native language title.
+
+ Bases: ParentModel
Media trailer or advertisement.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+id: str | None = None
+The trailer video id.
+class-attribute
+ instance-attribute
+
+
+site: str | None = None
+The site the video is hosted by (Currently either youtube or dailymotion).
+class-attribute
+ instance-attribute
+
+
+thumbnail: HttpUrl | None = None
+The url for the thumbnail image of the video.
+
+ Bases: Media
Subclass of Media with an additional relation_type property.
class-attribute
+ instance-attribute
+
+
+relation_type: MediaRelation | None = None
+The type of relation to the parent media.
+
+ Bases: ParentModel
Voice actors or production staff.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+age: int | None = None
+The person's age in years.
+class-attribute
+ instance-attribute
+
+
+blood_type: str | None = None
+The persons blood type.
+class-attribute
+ instance-attribute
+
+
+The staff's date of birth.
+class-attribute
+ instance-attribute
+
+
+The staff's date of death.
+class-attribute
+ instance-attribute
+
+
+description: str | None = None
+A general description of the staff member.
+class-attribute
+ instance-attribute
+
+
+favourites: int | None = None
+The amount of user's who have favourited the staff member.
+class-attribute
+ instance-attribute
+
+
+gender: str | None = None
+The staff's gender. Usually Male, Female, or Non-binary but can be any string.
+class-attribute
+ instance-attribute
+
+
+home_town: str | None = None
+The persons birthplace or hometown.
+class-attribute
+ instance-attribute
+
+
+id: int | None = None
+The id of the staff member.
+class-attribute
+ instance-attribute
+
+
+image: StaffImage = StaffImage()
+The staff images.
+class-attribute
+ instance-attribute
+
+
+language_v2: str | None = None
+The primary language of the staff member. +Current values: Japanese, English, Korean, +Italian, Spanish, Portuguese, French, German, +Hebrew, Hungarian, Chinese, Arabic, Filipino, +Catalan, Finnish, Turkish, Dutch, Swedish, Thai, +Tagalog, Malaysian, Indonesian, Vietnamese, Nepali, +Hindi, Urdu.
+class-attribute
+ instance-attribute
+
+
+The names of the staff member.
+class-attribute
+ instance-attribute
+
+
+The person's primary occupations.
+class-attribute
+ instance-attribute
+
+
+role: str | None = None
+The role of the staff member in the production of the media.
+class-attribute
+ instance-attribute
+
+
+site_url: HttpUrl | None = None
+The url for the staff page on the AniList website.
+class-attribute
+ instance-attribute
+
+
+years_active: YearsActive = YearsActive()
+(start_year, end_year) (If the 2nd value is not present staff is still active).
+
+ Bases: ParentModel
Staff's image.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+large: HttpUrl | None = None
+The person's image of media at its largest size.
+class-attribute
+ instance-attribute
+
+
+medium: HttpUrl | None = None
+The person's image of media at medium size.
+
+ Bases: ParentModel
The names of the staff member.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+Other names the staff member might be referred to as (pen names).
+class-attribute
+ instance-attribute
+
+
+first: str | None = None
+The person's given name.
+class-attribute
+ instance-attribute
+
+
+full: str | None = None
+The person's first and last name.
+class-attribute
+ instance-attribute
+
+
+last: str | None = None
+The person's surname.
+class-attribute
+ instance-attribute
+
+
+middle: str | None = None
+The person's middle name.
+class-attribute
+ instance-attribute
+
+
+native: str | None = None
+The person's full name in their native language.
+
+ Bases: ParentModel
Animation or production company.
+ + + + + + + + + +class-attribute
+ instance-attribute
+
+
+favourites: int | None = None
+The amount of user's who have favourited the studio.
+class-attribute
+ instance-attribute
+
+
+id: int | None = None
+The id of the studio.
+class-attribute
+ instance-attribute
+
+
+is_animation_studio: bool | None = None
+If the studio is an animation studio or a different kind of company.
+class-attribute
+ instance-attribute
+
+
+is_main: bool | None = None
+If the studio is the main animation studio of the anime.
+class-attribute
+ instance-attribute
+
+
+name: str | None = None
+The name of the studio.
+class-attribute
+ instance-attribute
+
+
+site_url: HttpUrl | None = None
+The url for the studio page on the AniList website.
+
+ Bases: NamedTuple
Simple Named Tuple for
+Staff.years_active.