Query Schemas Documentation¶

This is the documentation for the Query schemas.

Airing Schedule Schema¶

AIRINGSCHEDULESCHEMA `module-attribute` ¶

AIRINGSCHEDULESCHEMA = f'
  id
  airingAt
  timeUntilAiring
  episode
  mediaId
  media {
    {MEDIASCHEMA}
  }
'

AiringScheduleSchema is a string representing the GraphQL schema for an airing schedule query. It includes the id, airing time, time until airing, episode number, media id, and the media schema.

ATTRIBUTE	DESCRIPTION
`id`	The id of the airing schedule. TYPE: `int`
`airingAt`	The airing time of the airing schedule. TYPE: `int`
`timeUntilAiring`	The time until airing of the airing schedule. TYPE: `int`
`episode`	The episode number of the airing schedule. TYPE: `int`
`mediaId`	The media id of the airing schedule. TYPE: `int`
`media`	The media schema of the airing schedule. TYPE: `str`

Character Schema¶

CHARACTERSCHEMA `module-attribute` ¶

CHARACTERSCHEMA = f'
  id
  {NAMESCHEMA}
  {IMAGESCHEMA}
  description(asHtml: $asHtml)
  gender
  dateOfBirth {
    {FUZZYDATESCHEMA}
  }
  age
  bloodType
  isFavourite
  isFavouriteBlocked
  siteUrl
  media(sort: $mediaSort, onList: $mediaOnList, page: $mediaPage, perPage: $mediaPerPage) {
    nodes {
      id
      {TITLESCHEMA}
    }
  }
  favourites
  modNotes
'

CharacterSchema is a string representing the GraphQL schema for a character query. It includes the character's id, name, image, description, gender, date of birth, age, blood type, favourite status, site URL, associated media, number of favourites, and moderator notes.

ATTRIBUTE	DESCRIPTION
`id`	The id of the character. TYPE: `int`
`name`	The name schema of the character. TYPE: `str`
`image`	The image schema of the character. TYPE: `str`
`description`	The description of the character. TYPE: `str`
`gender`	The gender of the character. TYPE: `str`
`dateOfBirth`	The fuzzy date schema of the character's date of birth. TYPE: `str`
`age`	The age of the character. TYPE: `int`
`bloodType`	The blood type of the character. TYPE: `str`
`isFavourite`	The favourite status of the character. TYPE: `bool`
`isFavouriteBlocked`	The favourite blocked status of the character. TYPE: `bool`
`siteUrl`	The site URL of the character. TYPE: `str`
`media`	The media schema of the character. TYPE: `str`
`favourites`	The number of favourites of the character. TYPE: `int`
`modNotes`	The moderator notes of the character. TYPE: `str`

Media List Collection Schema¶

MEDIALISTCOLLECTIONSCHEMA `module-attribute` ¶

MEDIALISTCOLLECTIONSCHEMA = f'
  lists {
    entries {
      {MEDIALISTSCHEMA}
    name
    isCustomList
    isSplitCompletedList
    status
    }
  hasNextChunk
  }
'

MediaListCollectionQuerySchema is a string representing the GraphQL schema for a media list collection query. It includes the media list collection, lists, entries, user, and hasNextChunk status.

ATTRIBUTE	DESCRIPTION
`lists`	The lists of the media list collection. TYPE: `list`
`entries`	The entries of the media list collection. TYPE: `list`
`hasNextChunk`	The hasNextChunk status of the media list collection. TYPE: `bool`

Media List Schema¶

MEDIALISTSCHEMA `module-attribute` ¶

MEDIALISTSCHEMA = f'
  id
  userId
  mediaId
  status
  score (format: $ScoreFormat)
  progress
  progressVolumes
  repeat
  priority
  private
  notes
  hiddenFromStatusLists
  customLists (asArray: $asArray)
  advancedScores
  startedAt {
    {FUZZYDATESCHEMA}
  }
  completedAt {
    {FUZZYDATESCHEMA}
  }
  updatedAt
  createdAt
  media {
    {MEDIASCHEMA}
  }
'

MediaListSchema is a string representing the GraphQL schema for a media list query. It includes the id, user id, media id, status, score, progress, progress volumes, repeat, priority, private status, notes, hidden from status lists status, custom lists, advanced scores, started at date, completed at date, updated at timestamp, created at timestamp, media, and user.

ATTRIBUTE	DESCRIPTION
`id`	The id of the media list. TYPE: `int`
`userId`	The user id of the media list. TYPE: `int`
`mediaId`	The media id of the media list. TYPE: `int`
`status`	The status of the media list. TYPE: `str`
`score`	The score of the media list. TYPE: `str`
`progress`	The progress of the media list. TYPE: `int`
`progressVolumes`	The progress volumes of the media list. TYPE: `int`
`repeat`	The repeat of the media list. TYPE: `int`
`priority`	The priority of the media list. TYPE: `int`
`private`	The private status of the media list. TYPE: `bool`
`notes`	The notes of the media list. TYPE: `str`
`hiddenFromStatusLists`	The hidden from status lists status of the media list. TYPE: `bool`
`customLists`	The custom lists of the media list. TYPE: `str`
`advancedScores`	The advanced scores of the media list. TYPE: `list`
`startedAt`	The started at date of the media list. TYPE: `str`
`completedAt`	The completed at date of the media list. TYPE: `str`
`updatedAt`	The updated at timestamp of the media list. TYPE: `int`
`createdAt`	The created at timestamp of the media list. TYPE: `int`
`media`	The media of the media list. TYPE: `str`

Media Schema¶

MEDIASCHEMA `module-attribute` ¶

MEDIASCHEMA = f'
  id
  idMal
  {TITLESCHEMA}
  type
  format
  status
  description (asHtml: $asHtml)
  startDate {
    {FUZZYDATESCHEMA}
  }
  endDate {
    {FUZZYDATESCHEMA}
  }
  season
  seasonYear
  seasonInt
  episodes
  duration
  chapters
  volumes
  countryOfOrigin
  isLicensed
  source
  hashtag
  {TRAILERSCHEMA}
  updatedAt
  {COVERIMAGESCHEMA}
  bannerImage
  genres
  synonyms
  averageScore
  meanScore
  popularity
  isLocked
  trending
  favourites
  tags {
    {TAGSCHEMA}
  }
  isFavourite
  isAdult
  {NEXTAIRINGEPISODESCHEMA}
  {EXTERNALLINKSCHEMA}
  {STREAMINGEPISODESCHEMA}
  {RANKINGSCHEMA}
  {MEDIALISTENTRYSCHEMA}
  stats {
    {STATUSDISTRIBUTIONSCHEMA}
    {SCOREDISTRIBUTIONSCHEMA}
  }
  siteUrl
  autoCreateForumThread
  isRecommendationBlocked
  modNotes
'

This is the MediaSchema for the AniList API. It defines the structure of the media data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`id`	The media's ID. TYPE: `int`
`idMal`	The media's ID on MyAnimeList. TYPE: `int`
`title`	The media's title, with 'romaji', 'english', and 'native' versions. TYPE: `dict`
`type`	The type of the media (e.g., ANIME or MANGA). TYPE: `str`
`format`	The format of the media (e.g., TV, TV_SHORT, MOVIE, SPECIAL, OVA, ONA, MUSIC, MANGA, NOVEL, ONE_SHOT). TYPE: `str`
`status`	The status of the media (e.g., FINISHED, RELEASING, NOT_YET_RELEASED, CANCELLED). TYPE: `str`
`description`	The media's description. TYPE: `str`
`startDate`	The media's start date, with 'year', 'month', and 'day'. TYPE: `dict`
`endDate`	The media's end date, with 'year', 'month', and 'day'. TYPE: `dict`
`season`	The media's season (e.g., WINTER, SPRING, SUMMER, FALL). TYPE: `str`
`seasonYear`	The year of the media's season. TYPE: `int`
`seasonInt`	The integer representation of the media's season. TYPE: `int`
`episodes`	The number of episodes in the media. TYPE: `int`
`duration`	The duration of each episode in the media. TYPE: `int`
`chapters`	The number of chapters in the media. TYPE: `int`
`volumes`	The number of volumes in the media. TYPE: `int`
`countryOfOrigin`	The country of origin of the media. TYPE: `str`
`isLicensed`	Whether the media is licensed. TYPE: `bool`
`source`	The source of the media (e.g., ORIGINAL, MANGA, LIGHT_NOVEL, VISUAL_NOVEL, VIDEO_GAME, OTHER). TYPE: `str`
`hashtag`	The media's hashtag. TYPE: `str`
`updatedAt`	The timestamp of when the media was last updated. TYPE: `int`
`coverImage`	The media's cover image, with 'extraLarge', 'large', 'medium', and 'color' versions. TYPE: `dict`
`bannerImage`	The URL of the media's banner image. TYPE: `str`
`genres`	The media's genres. TYPE: `list`
`synonyms`	The media's synonyms. TYPE: `list`
`averageScore`	The media's average score. TYPE: `int`
`meanScore`	The media's mean score. TYPE: `int`
`popularity`	The media's popularity. TYPE: `int`
`isLocked`	Whether the media is locked. TYPE: `bool`
`trending`	The media's trending rank. TYPE: `int`
`favourites`	The number of users who have the media in their favourites. TYPE: `int`
`tags`	The media's tags. TYPE: `list`
`isFavourite`	Whether the media is a favourite. TYPE: `bool`
`isAdult`	Whether the media is for adults. TYPE: `bool`
`nextAiringEpisode`	The media's next airing episode, with 'airingAt', 'timeUntilAiring', and 'episode'. TYPE: `dict`
`externalLinks`	The media's external links. TYPE: `list`
`streamingEpisodes`	The media's streaming episodes. TYPE: `list`
`rankings`	The media's rankings. TYPE: `list`
`mediaListEntry`	The media's list entry. TYPE: `dict`
`stats`	The media's stats. TYPE: `dict`
`siteUrl`	The media's site URL. TYPE: `str`
`autoCreateForumThread`	Whether a forum thread is automatically created for the media. TYPE: `bool`
`isRecommendationBlocked`	Whether recommendation is blocked for the media. TYPE: `bool`
`modNotes`	The moderator's notes for the media. TYPE: `str`

Media Trend Schema¶

MEDIATRENDSCHEMA `module-attribute` ¶

MEDIATRENDSCHEMA = f'
  mediaId
  date
  trending
  averageScore
  popularity
  inProgress
  releasing
  episode
  media {
    {MEDIASCHEMA}
  }
'

MediaTrendSchema is a string representing the GraphQL schema for a media trend query. It includes the media's id, date, trending status, average score, popularity, in progress status, releasing status, episode number, and media of type Media.

ATTRIBUTE	DESCRIPTION
`mediaId`	The id of the media. TYPE: `int`
`date`	The date of the media trend. TYPE: `int`
`trending`	The trending status of the media. TYPE: `int`
`averageScore`	The average score of the media. TYPE: `int`
`popularity`	The popularity of the media. TYPE: `int`
`inProgress`	The in progress status of the media. TYPE: `bool`
`releasing`	The releasing status of the media. TYPE: `bool`
`episode`	The episode number of the media. TYPE: `int`
`media`	The media schema of the media. TYPE: `str`

Media With Relations Schema¶

MEDIAWITHRELATIONSSCHEMA `module-attribute` ¶

MEDIAWITHRELATIONSSCHEMA = f'
  id
  idMal
  {TITLESCHEMA}
  type
  format
  status
  description (asHtml: $asHtml)
  startDate {
    {FUZZYDATESCHEMA}
  }
  endDate {
    {FUZZYDATESCHEMA}
  }
  season
  seasonYear
  seasonInt
  episodes
  duration
  chapters
  volumes
  countryOfOrigin
  isLicensed
  source
  hashtag
  {TRAILERSCHEMA}
  updatedAt
  {COVERIMAGESCHEMA}
  bannerImage
  genres
  synonyms
  averageScore
  meanScore
  popularity
  isLocked
  trending
  favourites
  tags {
    {TAGSCHEMA}
  }
  relations {
    edges {
      id
      relationType
      isMainStudio
      characters {
        id
        {NAMESCHEMA}
        {IMAGESCHEMA}
        description (asHtml: $asHtml)
        gender
        dateOfBirth {
          {FUZZYDATESCHEMA}
        }
        age
        bloodType
        isFavourite
        isFavouriteBlocked
        siteUrl
        favourites
        modNotes
      }
      characterRole
      characterName
      roleNotes
      dubGroup
      staffRole
      node {
        id
        {TITLESCHEMA}
      }
    }
  }
  characters {
    edges {
      id
      role
      name
      voiceActors {
        id
        {NAMESCHEMA}
        {IMAGESCHEMA}
      }
      media {
        id
        {TITLESCHEMA}
        {COVERIMAGESCHEMA}
      }
      favouriteOrder
      node {
        id
        {NAMESCHEMA}
        {IMAGESCHEMA}
      }
    }
  }
  staff {
    edges {
      id
      role
      favouriteOrder
      node {
        id
        {NAMESCHEMA}
        {IMAGESCHEMA}
      }
    }
  }
  studios {
    edges {
      id
      isMain
      favouriteOrder
      node {
        id
        name
        isAnimationStudio
        siteUrl
      }
    }
  }
  isFavourite
  isAdult
  {NEXTAIRINGEPISODESCHEMA}
  {EXTERNALLINKSCHEMA}
  {STREAMINGEPISODESCHEMA}
  {RANKINGSCHEMA}
  {MEDIALISTENTRYSCHEMA}
  stats {
    {STATUSDISTRIBUTIONSCHEMA}
    {SCOREDISTRIBUTIONSCHEMA}
  }
  siteUrl
  autoCreateForumThread
  isRecommendationBlocked
  modNotes
'

This is the schema for a media with relations Query.

ATTRIBUTE	DESCRIPTION
`id`	The media's ID. TYPE: `int`
`idMal`	The media's ID on MyAnimeList. TYPE: `int`
`title`	The media's title, with 'romaji', 'english', and 'native' versions. TYPE: `dict`
`type`	The type of the media (e.g., ANIME or MANGA). TYPE: `str`
`format`	The format of the media (e.g., TV, TV_SHORT, MOVIE, SPECIAL, OVA, ONA, MUSIC, MANGA, NOVEL, ONE_SHOT). TYPE: `str`
`status`	The status of the media (e.g., FINISHED, RELEASING, NOT_YET_RELEASED, CANCELLED). TYPE: `str`
`description`	The media's description. TYPE: `str`
`startDate`	The media's start date, with 'year', 'month', and 'day'. TYPE: `dict`
`endDate`	The media's end date, with 'year', 'month', and 'day'. TYPE: `dict`
`season`	The media's season (e.g., WINTER, SPRING, SUMMER, FALL). TYPE: `str`
`seasonYear`	The year of the media's season. TYPE: `int`
`seasonInt`	The integer representation of the media's season. TYPE: `int`
`episodes`	The number of episodes in the media. TYPE: `int`
`duration`	The duration of each episode in the media. TYPE: `int`
`chapters`	The number of chapters in the media. TYPE: `int`
`volumes`	The number of volumes in the media. TYPE: `int`
`countryOfOrigin`	The country of origin of the media. TYPE: `str`
`isLicensed`	Whether the media is licensed. TYPE: `bool`
`source`	The source of the media (e.g., ORIGINAL, MANGA, LIGHT_NOVEL, VISUAL_NOVEL, VIDEO_GAME, OTHER). TYPE: `str`
`hashtag`	The media's hashtag. TYPE: `str`
`updatedAt`	The timestamp of when the media was last updated. TYPE: `int`
`coverImage`	The media's cover image, with 'extraLarge', 'large', 'medium', and 'color' versions. TYPE: `dict`
`bannerImage`	The URL of the media's banner image. TYPE: `str`
`genres`	The media's genres. TYPE: `list`
`synonyms`	The media's synonyms. TYPE: `list`
`averageScore`	The media's average score. TYPE: `int`
`meanScore`	The media's mean score. TYPE: `int`
`popularity`	The media's popularity. TYPE: `int`
`isLocked`	Whether the media is locked. TYPE: `bool`
`trending`	The media's trending rank. TYPE: `int`
`favourites`	The number of users who have the media in their favourites. TYPE: `int`
`tags`	The media's tags. TYPE: `list`
`isFavourite`	Whether the media is a favourite. TYPE: `bool`
`isAdult`	Whether the media is for adults. TYPE: `bool`
`nextAiringEpisode`	The media's next airing episode, with 'airingAt', 'timeUntilAiring', and 'episode'. TYPE: `dict`
`externalLinks`	The media's external links. TYPE: `list`
`streamingEpisodes`	The media's streaming episodes. TYPE: `list`
`rankings`	The media's rankings. TYPE: `list`
`mediaListEntry`	The media's list entry. TYPE: `dict`
`stats`	The media's stats. TYPE: `dict`
`siteUrl`	The media's site URL. TYPE: `str`
`autoCreateForumThread`	Whether a forum thread is automatically created for the media. TYPE: `bool`
`isRecommendationBlocked`	Whether recommendation is blocked for the media. TYPE: `bool`
`modNotes`	The moderator's notes for the media. TYPE: `str`
`relations`	The media's relations with other entities, including characters, staff, and studios. TYPE: `dict`

Notification Schema¶

NOTIFICATIONSCHEMA `module-attribute` ¶

NOTIFICATIONSCHEMA = f'
  ... on AiringNotification {
    id
    type
    animeId
    episode
    contexts
    createdAt
    media {
      id
      {TITLESCHEMA}
    }
  }
  ... on FollowingNotification {
    id
    type
    userId
    context
    createdAt
    user {
      {BASICUSERSCHEMA}
    }
  }
  ... on ActivityMessageNotification {
    id
    userId
    type
    activityId
    context
    createdAt
    message {
      id
      recipientId
      messengerId
      type
      replyCount
      message (asHtml: $asHtml)
      isLocked
      isSubscribed
      likeCount
      isLiked
      isPrivate
      siteUrl
      createdAt
      replies {
        id
        userId
        activityId
        text (asHtml: $asHtml)
        createdAt
        likeCount
        isLiked
        user {
          {BASICUSERSCHEMA}
        }
        likes {
          {BASICUSERSCHEMA}
        }
      }
      likes {
        {BASICUSERSCHEMA}
      }
    }
    user {
      {BASICUSERSCHEMA}
    }
  }
  ... on ActivityMentionNotification {
    {ACTIVITYNOTIFICATIONSCHEMA}
  }
  ... on ActivityReplyNotification {
    {ACTIVITYNOTIFICATIONSCHEMA}
  }
  ... on ActivityReplySubscribedNotification {
    {ACTIVITYNOTIFICATIONSCHEMA}
  }
  ... on ActivityLikeNotification {
    {ACTIVITYNOTIFICATIONSCHEMA}
  }
  ... on ActivityReplyLikeNotification {
    {ACTIVITYNOTIFICATIONSCHEMA}
  }
  ... on ThreadCommentMentionNotification {
    {THREADNOTIFICATIONSCHEMA}
  }
  ... on ThreadCommentReplyNotification {
    {THREADNOTIFICATIONSCHEMA}
  }
  ... on ThreadCommentSubscribedNotification {
    {THREADNOTIFICATIONSCHEMA}
  }
  ... on ThreadCommentLikeNotification {
    {THREADNOTIFICATIONSCHEMA}
  }
  ... on ThreadLikeNotification {
    id
    userId
    type
    context
    createdAt
    thread {
      ${BasicThreadSchema}
    }
    comment {
      {BASICCOMMENTSCHEMA}
    }
    user {
      {BASICUSERSCHEMA}
    }
  }
  ... on RelatedMediaAdditionNotification {
    id
    type
    mediaId
    context
    createdAt
    media {
      id
      {TITLESCHEMA}
    }
  }
  ... on MediaDataChangeNotification {
    id
    type
    mediaId
    context
    reason
    createdAt
    media {
      id
      {TITLESCHEMA}
    }
  }
  ... on MediaMergeNotification {
    id
    type
    mediaId
    deletedMediaTitles
    context
    reason
    createdAt
    media {
      id
      {TITLESCHEMA}
    }
  }
  ... on MediaDeletionNotification {
    id
    type
    deletedMediaTitle
    context
    reason
    createdAt
  }
'

NotificationSchema is a string representing the GraphQL schema for a notification query. It includes various types of notifications such as AiringNotification, FollowingNotification, ActivityMessageNotification, ActivityMentionNotification, ActivityReplyNotification, ActivityReplySubscribedNotification, ActivityLikeNotification, ActivityReplyLikeNotification, ThreadCommentMentionNotification, ThreadCommentReplyNotification, ThreadCommentSubscribedNotification, ThreadCommentLikeNotification, ThreadLikeNotification, RelatedMediaAdditionNotification, MediaDataChangeNotification, MediaMergeNotification, and MediaDeletionNotification.

ATTRIBUTE	DESCRIPTION
`id`	The id of the notification. TYPE: `int`
`type`	The type of the notification. TYPE: `str`
`animeId`	The anime id of the notification. TYPE: `int`
`episode`	The episode of the notification. TYPE: `int`
`contexts`	The contexts of the notification. TYPE: `list`
`createdAt`	The created at timestamp of the notification. TYPE: `int`
`media`	The media schema of the notification. TYPE: `str`
`userId`	The user id of the notification. TYPE: `int`
`context`	The context of the notification. TYPE: `str`
`user`	The basic user schema of the notification. TYPE: `str`
`activityId`	The activity id of the notification. TYPE: `int`
`message`	The message of the notification. TYPE: `str`
`thread`	The basic thread schema of the notification. TYPE: `str`
`comment`	The basic comment schema of the notification. TYPE: `str`
`mediaId`	The media id of the notification. TYPE: `int`
`reason`	The reason of the notification. TYPE: `str`
`deletedMediaTitles`	The deleted media titles of the notification. TYPE: `list`
`deletedMediaTitle`	The deleted media title of the notification. TYPE: `str`

Recommendation Schema¶

RECOMMENDATIONSCHEMA `module-attribute` ¶

RECOMMENDATIONSCHEMA = f'
  id
  rating
  userRating
  media {
    {MEDIASCHEMA}
  }
  mediaRecommendation {
    {MEDIASCHEMA}
  }
  user {
    {BASICUSERSCHEMA}
  }
'

RecommendationSchema is a string representing the GraphQL schema for a recommendation query. It includes the id, rating, user rating, media, media recommendation, and user.

ATTRIBUTE	DESCRIPTION
`id`	The id of the recommendation. TYPE: `int`
`rating`	The rating of the recommendation. TYPE: `int`
`userRating`	The user rating of the recommendation. TYPE: `int`
`media`	The media schema of the recommendation. TYPE: `str`
`mediaRecommendation`	The media recommendation schema of the recommendation. TYPE: `str`
`user`	The basic user schema of the recommendation. TYPE: `str`

Review Schema¶

REVIEWSCHEMA `module-attribute` ¶

REVIEWSCHEMA = f'
  id
  mediaId
  userId
  mediaType
  summary
  body (asHtml: $asHtml)
  rating
  ratingAmount
  score
  private
  siteUrl
  createdAt
  updatedAt
  user {
    {BASICUSERSCHEMA}
  }
  media {
    {MEDIASCHEMA}
  }
'

ReviewSchema is a string representing the GraphQL schema for a review query. It includes the id, mediaId, userId, mediaType, summary, body, rating, ratingAmount, score, private status, siteUrl, createdAt, updatedAt, user, and media.

ATTRIBUTE	DESCRIPTION
`id`	The id of the review. TYPE: `int`
`mediaId`	The media id of the review. TYPE: `int`
`userId`	The user id of the review. TYPE: `int`
`mediaType`	The media type of the review. TYPE: `str`
`summary`	The summary of the review. TYPE: `str`
`body`	The body of the review. TYPE: `str`
`rating`	The rating of the review. TYPE: `int`
`ratingAmount`	The rating amount of the review. TYPE: `int`
`score`	The score of the review. TYPE: `int`
`private`	The private status of the review. TYPE: `bool`
`siteUrl`	The site url of the review. TYPE: `str`
`createdAt`	The created at timestamp of the review. TYPE: `int`
`updatedAt`	The updated at timestamp of the review. TYPE: `int`
`user`	The basic user schema of the review. TYPE: `str`
`media`	The media schema of the review. TYPE: `str`

Site Statistics Schema¶

SITESTATISTICSSCHEMA `module-attribute` ¶

SITESTATISTICSSCHEMA = f'
  users (sort: $usersSort, page: $usersPage, perPage: $usersPerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
  anime (sort: $animeSort, page: $animePage, perPage: $animePerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
  manga (sort: $mangaSort, page: $mangaPage, perPage: $mangaPerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
  characters (sort: $charactersSort, page: $charactersPage, perPage: $charactersPerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
  staff (sort: $staffSort, page: $staffPage, perPage: $staffPerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
  studios (sort: $studiosSort, page: $studiosPage, perPage: $studiosPerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
  reviews (sort: $reviewsSort, page: $reviewsPage, perPage: $reviewsPerPage) {
    {SITETRENDCONNECTIONSCHEMA}
  }
'

SiteStatisticsSchema is a string representing the GraphQL schema for a site statistics query. It includes users, anime, manga, characters, staff, studios, and reviews of type SiteTrendConnection.

ATTRIBUTE	DESCRIPTION
`users`	The users schema of the site statistics. TYPE: `str`
`anime`	The anime schema of the site statistics. TYPE: `str`
`manga`	The manga schema of the site statistics. TYPE: `str`
`characters`	The characters schema of the site statistics. TYPE: `str`
`staff`	The staff schema of the site statistics. TYPE: `str`
`studios`	The studios schema of the site statistics. TYPE: `str`
`reviews`	The reviews schema of the site statistics. TYPE: `str`

Staff Schema¶

STAFFSCHEMA `module-attribute` ¶

STAFFSCHEMA = f'
  id
  {NAMESCHEMA}
  languageV2
  {IMAGESCHEMA}
  description(asHtml: $asHtml)
  primaryOccupations
  gender
  dateOfBirth {
    {FUZZYDATESCHEMA}
  }
  dateOfDeath {
    {FUZZYDATESCHEMA} } age yearsActive homeTown bloodType isFavourite isFavouriteBlocked siteUrl staffMedia (sort:
    $staffMediaSort, type: $staffMediaType, onList: $staffMediaOnList, page: $staffMediaPage,
    perPage: $staffMediaPerPage) { nodes { id {TITLESCHEMA}
    }
  }
  characters (sort: $charactersSort, page: $charactersPage, perPage: $charactersPerPage) {
    nodes {
      id
      {NAMESCHEMA} } } characterMedia (sort: $characterMediaSort, onList: $characterMediaOnList,
      page: $characterMediaPage, perPage: $characterMediaPerPage) { nodes { id {TITLESCHEMA}
    }
  }
  submitter {
    id
    name
  }
  submissionStatus
  submissionNotes
  favourites
  modNotes
'

StaffSchema is a string representing the GraphQL schema for a staff query. It includes the staff's id, name, language, image, description, primary occupations, gender, date of birth, date of death, age, years active, hometown, blood type, favourite status, favourite blocked status, site url, staff media, characters, character media, staff, submitter, submission status, submission notes, favourites, and mod notes.

ATTRIBUTE	DESCRIPTION
`id`	The id of the staff. TYPE: `int`
`name`	The name schema of the staff. TYPE: `str`
`languageV2`	The language of the staff. TYPE: `str`
`image`	The image schema of the staff. TYPE: `str`
`description`	The description of the staff. TYPE: `str`
`primaryOccupations`	The primary occupations of the staff. TYPE: `list`
`gender`	The gender of the staff. TYPE: `str`
`dateOfBirth`	The fuzzy date schema of the staff's date of birth. TYPE: `str`
`dateOfDeath`	The fuzzy date schema of the staff's date of death. TYPE: `str`
`age`	The age of the staff. TYPE: `int`
`yearsActive`	The years active of the staff. TYPE: `int`
`homeTown`	The hometown of the staff. TYPE: `str`
`bloodType`	The blood type of the staff. TYPE: `str`
`isFavourite`	The favourite status of the staff. TYPE: `bool`
`isFavouriteBlocked`	The favourite blocked status of the staff. TYPE: `bool`
`siteUrl`	The site url of the staff. TYPE: `str`
`staffMedia`	The staff media schema of the staff. TYPE: `str`
`characters`	The characters schema of the staff. TYPE: `str`
`characterMedia`	The character media schema of the staff. TYPE: `str`
`submitter`	The submitter of the staff. TYPE: `str`
`submissionStatus`	The submission status of the staff. TYPE: `int`
`submissionNotes`	The submission notes of the staff. TYPE: `str`
`favourites`	The favourites of the staff. TYPE: `int`
`modNotes`	The mod notes of the staff. TYPE: `str`

Studio Schema¶

STUDIOSCHEMA `module-attribute` ¶

STUDIOSCHEMA = f'
  id
  name
  isAnimationStudio
  media (sort: $mediaSort, isMain: $mediaIsMain onList: $mediaOnList, page: $mediaPage, perPage: $mediaPerPage) {
    edges {
      id
      relationType
      isMainStudio
      characters {
        {CHARACTERSCHEMA}
      }
      characterRole
      characterName
      roleNotes
      dubGroup
      voiceActors {
        {STAFFSCHEMA}
      }
      voiceActorRoles {
        voiceActor {
          id
          {NAMESCHEMA}
          {IMAGESCHEMA}
        }
        roleNotes
        dubGroup
      }
      favouriteOrder
      node {
        {MEDIASCHEMA}
      }
    }
    nodes {
      {MEDIASCHEMA}
    }
    pageInfo {
      total
      perPage
      currentPage
      lastPage
      hasNextPage
    }
  }
  siteUrl
  isFavourite
  favourites
'

StudioSchema is a string representing the GraphQL schema for a studio query. It includes the studio's id, name, animation studio status, media, site url, favourite status, and favourites count.

ATTRIBUTE	DESCRIPTION
`id`	The id of the studio. TYPE: `int`
`name`	The name of the studio. TYPE: `str`
`isAnimationStudio`	The animation studio status of the studio. TYPE: `bool`
`media`	The media schema of the studio. TYPE: `str`
`siteUrl`	The site url of the studio. TYPE: `str`
`isFavourite`	The favourite status of the studio. TYPE: `bool`
`favourites`	The favourites count of the studio. TYPE: `int`

Thread Comment Schema¶

THREADCOMMENTSCHEMA `module-attribute` ¶

THREADCOMMENTSCHEMA = f'
  id
  userId
  threadId
  comment (asHtml: $asHtml)
  likeCount
  isLiked
  siteUrl
  createdAt
  updatedAt
  thread {
    {THREADSCHEMA}
  }
  user {
    {BASICUSERSCHEMA}
  }
  likes {
    {BASICUSERSCHEMA}
  }
  childComments
  isLocked
'

ThreadCommentSchema is a string representing the GraphQL schema for a thread comment query. It includes the comment's id, userId, threadId, comment, likeCount, isLiked status, siteUrl, createdAt, updatedAt, thread of type ThreadResponse, user of type BasicUser, likes of type BasicUser[], childComments, and isLocked status.

ATTRIBUTE	DESCRIPTION
`id`	The id of the thread comment. TYPE: `int`
`userId`	The user id of the thread comment. TYPE: `int`
`threadId`	The thread id of the thread comment. TYPE: `int`
`comment`	The comment of the thread comment. TYPE: `str`
`likeCount`	The like count of the thread comment. TYPE: `int`
`isLiked`	The liked status of the thread comment. TYPE: `bool`
`siteUrl`	The site url of the thread comment. TYPE: `str`
`createdAt`	The created at timestamp of the thread comment. TYPE: `int`
`updatedAt`	The updated at timestamp of the thread comment. TYPE: `int`
`thread`	The thread schema of the thread comment. TYPE: `str`
`user`	The basic user schema of the thread comment. TYPE: `str`
`likes`	The basic user schema of the likes of the thread comment. TYPE: `str`
`childComments`	The child comments of the thread comment. TYPE: `str`
`isLocked`	The locked status of the thread comment. TYPE: `bool`

Thread Schema¶

THREADSCHEMA `module-attribute` ¶

THREADSCHEMA = f'
  id
  title
  body (asHtml: $asHtml)
  userId
  replyUserId
  replyCommentId
  replyCount
  viewCount
  isLocked
  isSticky
  isSubscribed
  likeCount
  isLiked
  repliedAt
  createdAt
  updatedAt
  user {
    {BASICUSERSCHEMA}
  }
  replyUser {
    {BASICUSERSCHEMA}
  }
  likes {
    {BASICUSERSCHEMA}
  }
  siteUrl
  categories {
    id
    name
  }
  mediaCategories {
    {MEDIASCHEMA}
  }
'

ThreadSchema is a string representing the GraphQL schema for a thread query. It includes the thread's id, title, body, userId, replyUserId, replyCommentId, replyCount, viewCount, isLocked status, isSticky status, isSubscribed status, likeCount, isLiked status, repliedAt, createdAt, updatedAt, user of type BasicUser, replyUser of type BasicUser, likes of type BasicUser[], siteUrl, categories, and mediaCategories of type MediaResponse[].

ATTRIBUTE	DESCRIPTION
`id`	The id of the thread. TYPE: `int`
`title`	The title of the thread. TYPE: `str`
`body`	The body of the thread. TYPE: `str`
`userId`	The user id of the thread. TYPE: `int`
`replyUserId`	The reply user id of the thread. TYPE: `int`
`replyCommentId`	The reply comment id of the thread. TYPE: `int`
`replyCount`	The reply count of the thread. TYPE: `int`
`viewCount`	The view count of the thread. TYPE: `int`
`isLocked`	The locked status of the thread. TYPE: `bool`
`isSticky`	The sticky status of the thread. TYPE: `bool`
`isSubscribed`	The subscribed status of the thread. TYPE: `bool`
`likeCount`	The like count of the thread. TYPE: `int`
`isLiked`	The liked status of the thread. TYPE: `bool`
`repliedAt`	The replied at timestamp of the thread. TYPE: `int`
`createdAt`	The created at timestamp of the thread. TYPE: `int`
`updatedAt`	The updated at timestamp of the thread. TYPE: `int`
`user`	The basic user schema of the thread. TYPE: `str`
`replyUser`	The basic user schema of the reply user of the thread. TYPE: `str`
`likes`	The basic user schema of the likes of the thread. TYPE: `str`
`siteUrl`	The site url of the thread. TYPE: `str`
`categories`	The categories of the thread. TYPE: `str`
`mediaCategories`	The media schema of the media categories of the thread. TYPE: `str`

User Schema¶

USERSCHEMA `module-attribute` ¶

USERSCHEMA = f'
  id
  name
  about(asHtml: $asHtml)
  avatar {
    large
    medium
  }
  bannerImage
  isFollowing
  isFollower
  isBlocked
  bans
  options {
    titleLanguage
    displayAdultContent
    airingNotifications
    profileColor
    notificationOptions {
      type
      enabled
    }
    timezone
    activityMergeTime
    staffNameLanguage
    restrictMessagesToFollowing
    disabledListActivity {
    disabled
    type
    }
  }
  mediaListOptions {
    scoreFormat
    rowOrder
    animeList {
      sectionOrder
      splitCompletedSectionByFormat
      customLists
      advancedScoring
      advancedScoringEnabled
    }
    mangaList {
      sectionOrder
      splitCompletedSectionByFormat
      customLists
      advancedScoring
      advancedScoringEnabled
    }
  }
  favourites {
    anime (perPage: 50) {
      edges {
        node {
          id
          {TITLESCHEMA}
        }
      }
      nodes {
        id
        {TITLESCHEMA}
      }
    }
    manga (perPage: 50) {
      edges {
        node {
        id
        {TITLESCHEMA}
        }
      }
      nodes {
        id
        {TITLESCHEMA}
      }
    }
    characters (perPage: 50) {
      edges {
        id
        role
        name
        voiceActors {
          id
          {NAMESCHEMA}
          {IMAGESCHEMA}
        }
        media {
          id
          {TITLESCHEMA}
          {COVERIMAGESCHEMA}
        }
        favouriteOrder
        node {
          id
          {NAMESCHEMA}
          {IMAGESCHEMA}
        }
      }
    }
    staff (perPage: 50) {
      edges {
        id
        role
        favouriteOrder
        node {
          id
          {NAMESCHEMA}
          {IMAGESCHEMA}
        }
      }
    }
    studios (perPage: 50) {
      edges {
        id
        isMain
        favouriteOrder
        node {
          id
          name
          isAnimationStudio
          siteUrl
        }
      }
    }
  }
  statistics {
    anime {
      count
      meanScore
      standardDeviation
      minutesWatched
      episodesWatched
      formats (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        format
      }
      statuses (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        status
      }
      scores (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        score
      }
      lengths (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        length
      }
      releaseYears (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        releaseYear
      }
      startYears (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        startYear
      }
      genres (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        genre
      }
      tags (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        tag {
          {TAGSCHEMA}
        }
      }
      countries (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        country
      }
      voiceActors (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        voiceActor {
          id
          {NAMESCHEMA}
        }
        characterIds
      }
      staff (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        staff {
          id
          {NAMESCHEMA}
        }
      }
      studios (limit: $animeStatLimit, sort: $animeStatSort) {
        {USERANIMESTATSSCHEMA}
        studio {
          id
          name
        }
      }
    }
    manga {
      count
      meanScore
      standardDeviation
      chaptersRead
      volumesRead
      formats (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        format
      }
      statuses (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        status
      }
      scores (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        score
      }
      lengths (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        length
      }
      releaseYears (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        releaseYear
      }
      startYears (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        startYear
      }
      genres (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        genre
      }
      tags (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        tag {
          {TAGSCHEMA}
        }
      }
      countries (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        country
      }
      staff (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        staff {
          id
          {NAMESCHEMA}
        }
      }
      studios (limit: $mangaStatLimit, sort: $mangaStatSort) {
        {USERMANGASTATSSCHEMA}
        studio {
          id
          name
        }
      }
    }
  }
  stats {
    watchedTime
    chaptersRead
    activityHistory {
      date
      amount
      level
    }
    animeStatusDistribution {
      status
      amount
    }
    mangaStatusDistribution {
      status
      amount
    }
    animeScoreDistribution {
      score
      amount
    }
    mangaScoreDistribution {
      score
      amount
    }
    animeListScores {
      meanScore
      standardDeviation
    }
    mangaListScores {
      meanScore
      standardDeviation
    }
    favouredGenresOverview {
      genre
      amount
      meanScore
      timeWatched
    }
    favouredGenres {
      genre
      amount
      meanScore
      timeWatched
    }
    favouredTags {
      tag {
        {TAGSCHEMA}
      }
      amount
      meanScore
      timeWatched
    }
    favouredActors {
      staff {
        id
        {NAMESCHEMA}
      }
      amount
      meanScore
      timeWatched
    }
    favouredStaff {
      staff {
        id
        {NAMESCHEMA}
      }
      amount
      meanScore
      timeWatched
    }
    favouredStudios {
      studio {
        id
        name
      }
      amount
      meanScore
      timeWatched
    }
    favouredYears {
      year
      amount
      meanScore
    }
    favouredFormats {
      format
      amount
    }
  }
  unreadNotificationCount
  siteUrl
  donatorTier
  donatorBadge
  moderatorRoles
  createdAt
  updatedAt
  previousNames {
    name
    createdAt
    updatedAt
  }
'

This is the UserSchema for the Anilist API. It defines the structure of the user data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`id`	The user's ID. TYPE: `int`
`name`	The user's name. TYPE: `str`
`about`	The user's about information. TYPE: `str`
`avatar`	The user's avatar, with 'large' and 'medium' sizes. TYPE: `dict`
`bannerImage`	The URL of the user's banner image. TYPE: `str`
`isFollowing`	Whether the user is following. TYPE: `bool`
`isFollower`	Whether the user is a follower. TYPE: `bool`
`isBlocked`	Whether the user is blocked. TYPE: `bool`
`bans`	The user's bans. TYPE: `list`
`options`	The user's options. TYPE: `dict`
`mediaListOptions`	The user's media list options. TYPE: `dict`
`favourites`	The user's favourites. TYPE: `dict`
`statistics`	The user's statistics. TYPE: `dict`
`stats`	The user's stats. TYPE: `dict`
`unreadNotificationCount`	The user's unread notification count. TYPE: `int`
`siteUrl`	The user's site URL. TYPE: `str`
`donatorTier`	The user's donator tier. TYPE: `int`
`donatorBadge`	The user's donator badge. TYPE: `str`
`moderatorRoles`	The user's moderator roles. TYPE: `list`
`createdAt`	The timestamp of when the user was created. TYPE: `int`
`updatedAt`	The timestamp of when the user was last updated. TYPE: `int`
`previousNames`	The user's previous names. TYPE: `list`

Query Schemas Documentation¶

Airing Schedule Schema¶

AIRINGSCHEDULESCHEMA module-attribute ¶

Character Schema¶

CHARACTERSCHEMA module-attribute ¶

Media List Collection Schema¶

MEDIALISTCOLLECTIONSCHEMA module-attribute ¶

Media List Schema¶

MEDIALISTSCHEMA module-attribute ¶