Anilist(api_url: str = 'https://graphql.anilist.co', retries: int = 5, **kwargs: HTTPXClientKwargs)
+Anilist API client.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
api_url |
+
+ str
+ |
+
+
+
+ The URL of the Anilist API. Default is "https://graphql.anilist.co". + |
+
+ 'https://graphql.anilist.co'
+ |
+
retries |
+
+ int
+ |
+
+
+
+ Number of times to retry a failed request before raising an error. Default is 5. + |
+
+ 5
+ |
+
kwargs |
+
+ HTTPXClientKwargs
+ |
+
+
+
+ Keyword arguments to pass to the underlying httpx.Client() +used to make the POST request. + |
+
+ {}
+ |
+
src/pyanilist/_clients/_sync.pysearch(title: AnilistTitle, season: MediaSeason | None = None, season_year: AnilistYear | None = None, type: MediaType | None = None, format: MediaFormat | None = None, status: MediaStatus | None = None) -> Media
+Search for media on Anilist based on the provided parameters.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
title |
+
+ AnilistTitle | None
+ |
+
+
+
+ The string used for searching on Anilist. + |
+ + required + | +
season |
+
+ MediaSeason | None
+ |
+
+
+
+ The season the media was initially released in. Default is None. + |
+
+ None
+ |
+
season_year |
+
+ AnilistYear | None
+ |
+
+
+
+ The season year the media was initially released in. Default is None. + |
+
+ None
+ |
+
type |
+
+ MediaType | None
+ |
+
+
+
+ The type of the media; anime or manga. Default is None. + |
+
+ None
+ |
+
format |
+
+ MediaFormat | None
+ |
+
+
+
+ The format the media was released in. Default is None. + |
+
+ None
+ |
+
status |
+
+ MediaStatus | None
+ |
+
+
+
+ The current releasing status of the media. Default is None. + |
+
+ None
+ |
+
Raises:
+| Type | +Description | +
|---|---|
+ ValidationError
+ |
+
+
+
+ Invalid input + |
+
+ HTTPStatusError
+ |
+
+
+
+ Anilist returned a non 2xx response. + |
+
Returns:
+| Type | +Description | +
|---|---|
+ Media
+ |
+
+
+
+ A Media object representing the retrieved media information. + |
+
src/pyanilist/_clients/_sync.pyRetrieve media information from Anilist based on it's ID.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
id |
+
+ int
+ |
+
+
+
+ Anilist ID of the media as found in the URL: https://anilist.co/{type}/{id}. + |
+ + required + | +
Raises:
+| Type | +Description | +
|---|---|
+ ValidationError
+ |
+
+
+
+ Invalid input + |
+
+ HTTPStatusError
+ |
+
+
+
+ Anilist returned a non 2xx response. + |
+
Returns:
+| Type | +Description | +
|---|---|
+ Media
+ |
+
+
+
+ A Media object representing the retrieved media information. + |
+
src/pyanilist/_clients/_sync.pyAsyncAnilist(api_url: str = 'https://graphql.anilist.co', retries: int = 5, **kwargs: HTTPXAsyncClientKwargs)
+Async Anilist API client.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
api_url |
+
+ str
+ |
+
+
+
+ The URL of the Anilist API. Default is "https://graphql.anilist.co". + |
+
+ 'https://graphql.anilist.co'
+ |
+
retries |
+
+ int
+ |
+
+
+
+ Number of times to retry a failed request before raising an error. Default is 5. + |
+
+ 5
+ |
+
kwargs |
+
+ HTTPXAsyncClientKwargs
+ |
+
+
+
+ Keyword arguments to pass to the underlying httpx.AsyncClient() +used to make the POST request. + |
+
+ {}
+ |
+
src/pyanilist/_clients/_async.pyasync
+
+
+search(title: AnilistTitle, season: MediaSeason | None = None, season_year: AnilistYear | None = None, type: MediaType | None = None, format: MediaFormat | None = None, status: MediaStatus | None = None) -> Media
+Search for media on Anilist based on the provided parameters.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
title |
+
+ AnilistTitle | None
+ |
+
+
+
+ The string used for searching on Anilist. + |
+ + required + | +
season |
+
+ MediaSeason | None
+ |
+
+
+
+ The season the media was initially released in. Default is None. + |
+
+ None
+ |
+
season_year |
+
+ AnilistYear | None
+ |
+
+
+
+ The season year the media was initially released in. Default is None. + |
+
+ None
+ |
+
type |
+
+ MediaType | None
+ |
+
+
+
+ The type of the media; anime or manga. Default is None. + |
+
+ None
+ |
+
format |
+
+ MediaFormat | None
+ |
+
+
+
+ The format the media was released in. Default is None. + |
+
+ None
+ |
+
status |
+
+ MediaStatus | None
+ |
+
+
+
+ The current releasing status of the media. Default is None. + |
+
+ None
+ |
+
Raises:
+| Type | +Description | +
|---|---|
+ ValidationError
+ |
+
+
+
+ Invalid input + |
+
+ HTTPStatusError
+ |
+
+
+
+ Anilist returned a non 2xx response. + |
+
Returns:
+| Type | +Description | +
|---|---|
+ Media
+ |
+
+
+
+ A Media object representing the retrieved media information. + |
+
src/pyanilist/_clients/_async.pyasync
+
+
+Retrieve media information from Anilist based on it's ID.
+ + + +Parameters:
+| Name | +Type | +Description | +Default | +
|---|---|---|---|
id |
+
+ int
+ |
+
+
+
+ Anilist ID of the media as found in the URL: https://anilist.co/{type}/{id}. + |
+ + required + | +
Raises:
+| Type | +Description | +
|---|---|
+ ValidationError
+ |
+
+
+
+ Invalid input + |
+
+ HTTPStatusError
+ |
+
+
+
+ Anilist returned a non 2xx response. + |
+
Returns:
+| Type | +Description | +
|---|---|
+ Media
+ |
+
+
+
+ A Media object representing the retrieved media information. + |
+
src/pyanilist/_clients/_async.py
+ Bases: StrEnum
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: StrEnum
External Link Type
+ + + + +class-attribute
+ instance-attribute
+
+
+Informational site
+class-attribute
+ instance-attribute
+
+
+Social media site
+
+ Bases: StrEnum
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: StrEnum
The type of ranking
+ + + + +class-attribute
+ instance-attribute
+
+
+Ranking is based on the media's popularity
+
+ Bases: StrEnum
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: StrEnum
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: StrEnum
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: StrEnum
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: StrEnum
The type of the media; anime or manga.
+ + + + + + +CloseError(message: str, *, request: Request | None = None)
+
+ Bases: NetworkError
Failed to close a connection.
+ + +ConnectError(message: str, *, request: Request | None = None)
+
+ Bases: NetworkError
Failed to establish a connection.
+ + +ConnectTimeout(message: str, *, request: Request | None = None)
+
+ Bases: TimeoutException
Timed out while connecting to the host.
+ + +CookieConflict(message: str)
+
+ Bases: Exception
Attempted to lookup a cookie by name, but multiple cookies existed.
+Can occur when calling response.cookies.get(...).
DecodingError(message: str, *, request: Request | None = None)
+
+ Bases: RequestError
Decoding of the response failed, due to a malformed encoding.
+ + +HTTPError(message: str)
+
+ Bases: Exception
Base class for RequestError and HTTPStatusError.
Useful for try...except blocks when issuing a request,
+and then calling .raise_for_status().
For example:
+try:
+ response = httpx.get("https://www.example.com")
+ response.raise_for_status()
+except httpx.HTTPError as exc:
+ print(f"HTTP Exception for {exc.request.url} - {exc}")
+HTTPStatusError(message: str, *, request: Request, response: Response)
+
+ Bases: HTTPError
The response had an error HTTP status of 4xx or 5xx.
+May be raised when calling response.raise_for_status()
InvalidURL(message: str)
+
+ Bases: Exception
URL is improperly formed or cannot be parsed.
+ + + + +LocalProtocolError(message: str, *, request: Request | None = None)
+
+ Bases: ProtocolError
A protocol was violated by the client.
+For example if the user instantiated a Request instance explicitly,
+failed to include the mandatory Host: header, and then issued it directly
+using client.send().
NetworkError(message: str, *, request: Request | None = None)
+
+ Bases: TransportError
The base class for network-related errors.
+An error occurred while interacting with the network.
+ + +PoolTimeout(message: str, *, request: Request | None = None)
+
+ Bases: TimeoutException
Timed out waiting to acquire a connection from the pool.
+ + +ProtocolError(message: str, *, request: Request | None = None)
+
+ Bases: TransportError
The protocol was violated.
+ + +ProxyError(message: str, *, request: Request | None = None)
+
+ Bases: TransportError
An error occurred while establishing a proxy connection.
+ + +ReadError(message: str, *, request: Request | None = None)
+
+ Bases: NetworkError
Failed to receive data from the network.
+ + +ReadTimeout(message: str, *, request: Request | None = None)
+
+ Bases: TimeoutException
Timed out while receiving data from the host.
+ + +RemoteProtocolError(message: str, *, request: Request | None = None)
+
+ Bases: ProtocolError
The protocol was violated by the server.
+For example, returning malformed HTTP.
+ + +RequestError(message: str, *, request: Request | None = None)
+
+ Bases: HTTPError
Base class for all exceptions that may occur when issuing a .request().
+ Bases: StreamError
Attempted to access streaming request content, without having called read().
+ Bases: StreamError
Attempted to access streaming response content, without having called read().
+ Bases: StreamError
Attempted to read or stream response content, but the request has been +closed.
+ + + + +
+ Bases: StreamError
Attempted to read or stream content, but the content has already +been streamed.
+ + + + +StreamError(message: str)
+
+ Bases: RuntimeError
The base class for stream exceptions.
+The developer made an error in accessing the request stream in +an invalid way.
+ + + + +TimeoutException(message: str, *, request: Request | None = None)
+
+ Bases: TransportError
The base class for timeout errors.
+An operation has timed out.
+ + +TooManyRedirects(message: str, *, request: Request | None = None)
+
+ Bases: RequestError
Too many redirects.
+ + +UnsupportedProtocol(message: str, *, request: Request | None = None)
+
+ Bases: TransportError
Attempted to make a request to an unsupported protocol.
+For example issuing a request to ftp://www.example.com.
WriteError(message: str, *, request: Request | None = None)
+
+ Bases: NetworkError
Failed to send data through the network.
+ + +WriteTimeout(message: str, *, request: Request | None = None)
+
+ Bases: TimeoutException
Timed out while sending data to the host.
+ + +module-attribute
+
+
+ValidationError = ValidationError
+
+ 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
+
+
+The characters in the media
+class-attribute
+ instance-attribute
+
+
+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
+
+
+Other media in the same or connecting franchise
+class-attribute
+ instance-attribute
+
+
+season: MediaSeason | None = None
+The season the media was initially released in
+class-attribute
+ instance-attribute
+
+
+season_int: int | None = None
+The year & 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
+
+
+Animation or production company
+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
+
+
+Animation or production company
+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
Media Airing Schedule.
+ + + + +class-attribute
+ instance-attribute
+
+
+airing_at: int | None = None
+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
+
+
+media_id: int | None = None
+The associate media id of the airing episode
+class-attribute
+ instance-attribute
+
+
+time_until_airing: int | None = None
+Seconds until 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 characters 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 characters 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
+Returns 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.py
+ Bases: ParentModel
The cover images of the media.
+ + + + +class-attribute
+ instance-attribute
+
+
+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
+
+
+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
+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
+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
+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: ParentModel
Related Anime or Manga to parent Media
+ + + + +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
+
+
+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
+
+
+relation_type: MediaRelation | None = None
+The type of relation to the parent model
+class-attribute
+ instance-attribute
+
+
+season: MediaSeason | None = None
+The season the media was initially released in
+class-attribute
+ instance-attribute
+
+
+season_int: int | None = None
+The year & 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
+class-attribute
+ instance-attribute
+
+
+site_url: HttpUrl | None = None
+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
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
+
+
+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
+Note
+Additionally, PyAnilist also uses and exports the following pydantic types for convenience:
+module-attribute
+
+
+AnilistID = Annotated[int, Field(gt=0, description='Anilist ID as found in the URL: https://anilist.co/{type}/{id}')]
+module-attribute
+
+
+module-attribute
+
+
+
+ Bases: NamedTuple
Simple Named Tuple for
+_models.Staff.years_active
module-attribute
+
+
+HTTPXAsyncClientKwargs: TypeAlias = Any
+Simple TypeAlias to refer to httpx.AsyncClient() kwargs
module-attribute
+
+
+HTTPXClientKwargs: TypeAlias = Any
+Simple TypeAlias to refer to httpx.Client() kwargs