animedex.backends.anilist

High-level AniList Python API.

Each public function corresponds to a subcommand of animedex anilist. The function takes typed arguments, calls animedex.api.anilist.call() to issue the GraphQL request, parses the body, and returns a typed dataclass from animedex.backends.anilist.models.

Token-required Query roots (Viewer, Notification, Markdown, AniChartUser) are exposed as functions that unconditionally raise ApiError(reason="auth-required") until the OAuth flow lands; the corresponding CLI subcommands surface that as a clean error.

• animedex.backends.anilist._mapper
  • map_media
    • map_media()
  • map_media_list
    • map_media_list()
  • map_character
    • map_character()
  • map_character_list
    • map_character_list()
  • map_staff
    • map_staff()
  • map_staff_list
    • map_staff_list()
  • map_studio
    • map_studio()
  • map_studio_list
    • map_studio_list()
  • map_user
    • map_user()
  • map_user_list
    • map_user_list()
  • map_genre_collection
    • map_genre_collection()
  • map_media_tag_collection
    • map_media_tag_collection()
  • map_site_statistics
    • map_site_statistics()
  • map_external_link_source
    • map_external_link_source()
  • map_airing_schedule
    • map_airing_schedule()
  • map_media_trend
    • map_media_trend()
  • map_review
    • map_review()
  • map_recommendation
    • map_recommendation()
  • map_thread
    • map_thread()
  • map_thread_comment
    • map_thread_comment()
  • map_activity
    • map_activity()
  • map_activity_reply
    • map_activity_reply()
  • map_follow
    • map_follow()
  • map_media_list_public
    • map_media_list_public()
  • map_viewer
    • map_viewer()
  • map_notification
    • map_notification()
  • map_markdown
    • map_markdown()
  • map_ani_chart_user
    • map_ani_chart_user()
  • map_media_list_collection_public
    • map_media_list_collection_public()
• animedex.backends.anilist._queries
  • Q_MEDIA_BY_ID
    • Q_MEDIA_BY_ID
  • Q_MEDIA_SEARCH
    • Q_MEDIA_SEARCH
  • Q_CHARACTER_BY_ID
    • Q_CHARACTER_BY_ID
  • Q_CHARACTER_SEARCH
    • Q_CHARACTER_SEARCH
  • Q_STAFF_BY_ID
    • Q_STAFF_BY_ID
  • Q_STAFF_SEARCH
    • Q_STAFF_SEARCH
  • Q_STUDIO_BY_ID
    • Q_STUDIO_BY_ID
  • Q_STUDIO_SEARCH
    • Q_STUDIO_SEARCH
  • Q_SCHEDULE
    • Q_SCHEDULE
  • Q_TRENDING
    • Q_TRENDING
  • Q_USER_BY_NAME
    • Q_USER_BY_NAME
  • Q_USER_SEARCH
    • Q_USER_SEARCH
  • Q_GENRE_COLLECTION
    • Q_GENRE_COLLECTION
  • Q_MEDIA_TAG_COLLECTION
    • Q_MEDIA_TAG_COLLECTION
  • Q_SITE_STATISTICS
    • Q_SITE_STATISTICS
  • Q_EXTERNAL_LINK_SOURCE_COLLECTION
    • Q_EXTERNAL_LINK_SOURCE_COLLECTION
  • Q_AIRING_SCHEDULE
    • Q_AIRING_SCHEDULE
  • Q_MEDIA_TREND
    • Q_MEDIA_TREND
  • Q_REVIEW
    • Q_REVIEW
  • Q_RECOMMENDATION
    • Q_RECOMMENDATION
  • Q_THREAD
    • Q_THREAD
  • Q_THREAD_COMMENT
    • Q_THREAD_COMMENT
  • Q_ACTIVITY
    • Q_ACTIVITY
  • Q_ACTIVITY_REPLY
    • Q_ACTIVITY_REPLY
  • Q_FOLLOWING
    • Q_FOLLOWING
  • Q_FOLLOWER
    • Q_FOLLOWER
  • Q_MEDIA_LIST_PUBLIC
    • Q_MEDIA_LIST_PUBLIC
  • Q_MEDIA_LIST_COLLECTION_PUBLIC
    • Q_MEDIA_LIST_COLLECTION_PUBLIC
  • Q_VIEWER
    • Q_VIEWER
  • Q_NOTIFICATION
    • Q_NOTIFICATION
  • Q_MARKDOWN
    • Q_MARKDOWN
  • Q_ANI_CHART_USER
    • Q_ANI_CHART_USER
• animedex.backends.anilist.models
  • AnilistAnime
    • AnilistAnime
  • AnilistCharacter
    • AnilistCharacter
  • AnilistStaff
    • AnilistStaff
  • AnilistStudio
    • AnilistStudio
  • AnilistMediaTrend
    • AnilistMediaTrend
  • AnilistAiringSchedule
    • AnilistAiringSchedule
  • AnilistReview
    • AnilistReview
  • AnilistRecommendation
    • AnilistRecommendation
  • AnilistThread
    • AnilistThread
  • AnilistThreadComment
    • AnilistThreadComment
  • AnilistActivity
    • AnilistActivity
  • AnilistActivityReply
    • AnilistActivityReply
  • AnilistFollowEntry
    • AnilistFollowEntry
  • AnilistMediaListEntry
    • AnilistMediaListEntry
  • AnilistMediaListGroup
    • AnilistMediaListGroup
  • AnilistMediaListCollection
    • AnilistMediaListCollection
  • AnilistGenreCollection
    • AnilistGenreCollection
  • AnilistMediaTag
    • AnilistMediaTag
  • AnilistSiteStatBucket
    • AnilistSiteStatBucket
  • AnilistSiteStatistics
    • AnilistSiteStatistics
  • AnilistExternalLinkSource
    • AnilistExternalLinkSource
  • AnilistUserStatistics
    • AnilistUserStatistics
  • AnilistUser
    • AnilistUser
  • AnilistNotification
    • AnilistNotification
  • AnilistMarkdown
    • AnilistMarkdown
  • AnilistAniChartUser
    • AnilistAniChartUser
  • selftest
    • selftest()

show

animedex.backends.anilist.show(id: int, *, config: Config | None = None, **kw) → AnilistAnime

Fetch a single AniList Media (anime/manga) by id.

Parameters:

• id (int) – AniList Media id.

• config (Config or None) – Optional Config overrides.

Returns:

Rich AniList record.

Return type:

AnilistAnime

Raises:

ApiError – reason='not-found' when the id is unknown.

search

animedex.backends.anilist.search(q: str, *, page: int = 1, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistAnime]

Search anime by title.

Parameters:

• q (str) – Free-text query.

• page (int) – 1-based page index.

• per_page (int) – Page size; AniList caps at 50.

Returns:

List of matching AniList records.

Return type:

list[AnilistAnime]

manga_search

animedex.backends.anilist.manga_search(q: str, *, page: int = 1, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistAnime]

Search manga by title.

character

animedex.backends.anilist.character(id: int, *, config: Config | None = None, **kw) → AnilistCharacter

Fetch a single AniList Character by id.

character_search

animedex.backends.anilist.character_search(q: str, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistCharacter]

Search AniList characters by name.

staff

animedex.backends.anilist.staff(id: int, *, config: Config | None = None, **kw) → AnilistStaff

Fetch a single AniList Staff by id.

staff_search

animedex.backends.anilist.staff_search(q: str, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistStaff]

Search AniList staff by name.

studio

animedex.backends.anilist.studio(id: int, *, config: Config | None = None, **kw) → AnilistStudio

Fetch a single AniList Studio by id.

studio_search

animedex.backends.anilist.studio_search(q: str, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistStudio]

Search AniList studios by name.

schedule

animedex.backends.anilist.schedule(year: int, season: str, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistAnime]

List anime airing in the given season.

Parameters:

• year (int) – Calendar year.

• season (str) – One of "WINTER", "SPRING", "SUMMER", "FALL" (case-insensitive).

trending

animedex.backends.anilist.trending(*, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistAnime]

List currently-trending AniList anime.

user

animedex.backends.anilist.user(name: str, *, config: Config | None = None, **kw) → AnilistUser

Fetch an AniList user profile by name (public endpoint).

user_search

animedex.backends.anilist.user_search(q: str, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistUser]

Search AniList users by name.

genre_collection

animedex.backends.anilist.genre_collection(*, config: Config | None = None, **kw) → AnilistGenreCollection

The full AniList genre vocabulary.

media_tag_collection

animedex.backends.anilist.media_tag_collection(*, config: Config | None = None, **kw) → List[AnilistMediaTag]

The full AniList tag taxonomy with categories + spoiler flags.

site_statistics

animedex.backends.anilist.site_statistics(*, config: Config | None = None, **kw) → AnilistSiteStatistics

AniList-wide entity counts (latest snapshot row per category).

external_link_source_collection

animedex.backends.anilist.external_link_source_collection(media_type: str = 'ANIME', type: str = 'STREAMING', *, config: Config | None = None, **kw) → List[AnilistExternalLinkSource]

List the registered external sites (streaming, info, social).

Parameters:

• media_type – "ANIME" or "MANGA".

• type – "STREAMING", "INFO", or "SOCIAL".

airing_schedule

animedex.backends.anilist.airing_schedule(*, media_id: int | None = None, not_yet_aired: bool | None = None, airing_at_greater: int | None = None, airing_at_lesser: int | None = None, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistAiringSchedule]

Upcoming-episode schedule, optionally filtered.

media_trend

animedex.backends.anilist.media_trend(media_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistMediaTrend]

Daily score / popularity trend rows for one Media.

review

animedex.backends.anilist.review(media_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistReview]

User reviews for a given Media id.

recommendation

animedex.backends.anilist.recommendation(media_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistRecommendation]

Media-to-media recommendations rooted at media_id.

thread

animedex.backends.anilist.thread(q: str, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistThread]

Search forum threads.

thread_comment

animedex.backends.anilist.thread_comment(thread_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistThreadComment]

Comments on a single forum thread.

activity

animedex.backends.anilist.activity(*, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistActivity]

Recent global activity (text + list).

activity_reply

animedex.backends.anilist.activity_reply(activity_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistActivityReply]

Replies to a public activity item.

following

animedex.backends.anilist.following(user_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistFollowEntry]

Users a given user follows.

follower

animedex.backends.anilist.follower(user_id: int, *, per_page: int = 10, config: Config | None = None, **kw) → List[AnilistFollowEntry]

Users following a given user.

media_list_public

animedex.backends.anilist.media_list_public(user_name: str, *, type: str = 'ANIME', per_page: int = 10, config: Config | None = None, **kw) → List[AnilistMediaListEntry]

A public user’s MediaList rows (read-only).

Parameters:

• user_name – AniList username.

• type – "ANIME" or "MANGA".

media_list_collection_public

animedex.backends.anilist.media_list_collection_public(user_name: str, *, type: str = 'ANIME', config: Config | None = None, **kw) → AnilistMediaListCollection

A public user’s full list grouped by status.

viewer

animedex.backends.anilist.viewer(*, config: Config | None = None, **kw)

Current user profile. Requires authentication.

Raises:

ApiError – Always, until the OAuth flow lands.

notification

animedex.backends.anilist.notification(*, config: Config | None = None, **kw)

Notifications. Token-required.

markdown

animedex.backends.anilist.markdown(text: str, *, config: Config | None = None, **kw)

AniList-markdown to HTML. Token-required.

ani_chart_user

animedex.backends.anilist.ani_chart_user(*, config: Config | None = None, **kw)

AniChart user state. Token-required.

selftest

animedex.backends.anilist.selftest() → bool

Smoke-test the AniList Python API.

Without hitting the network: confirms every public callable exists and the auth-required stubs raise correctly.