Basic Schema Documentation¶

This is the documentation for the basic schemas.

Activity Schema¶

ACTIVITYNOTIFICATIONSCHEMA `module-attribute` ¶

ACTIVITYNOTIFICATIONSCHEMA = f'
  id
  userId
  type
  activityId
  context
  createdAt
  {ACTIVITYSCHEMA}
    user {
      {BASICUSERSCHEMA}
    }
'

This is the ActivityNotificationSchema for the Anilist API. It defines the structure of the activity notification data.

ATTRIBUTE	DESCRIPTION
`id`	The id of the notification. TYPE: `int`
`userId`	The id of the user who created the notification. TYPE: `int`
`type`	The type of the notification. TYPE: `str`
`activityId`	The id of the activity related to the notification. TYPE: `int`
`context`	The context of the notification. TYPE: `str`
`createdAt`	The timestamp when the notification was created. TYPE: `int`
`ActivitySchema`	The details of the activity related to the notification. TYPE: `str`
`BASICUSERSCHEMA`	The details of the user who created the notification. TYPE: `str`

ACTIVITYREPLYSCHEMA `module-attribute` ¶

ACTIVITYREPLYSCHEMA = f'
  id
  userId
  activityId
  text (asHtml: $asHtml)
  likeCount
  isLiked
  createdAt
  user {
    {BASICUSERSCHEMA}
  }
  likes {
    {BASICUSERSCHEMA}
  }
'

This is the ActivityReplySchema for the Anilist API. It defines the structure of the activity reply data.

ATTRIBUTE	DESCRIPTION
`id`	The id of the activity. TYPE: `int`
`userId`	The id of the user who created the activity. TYPE: `int`
`activityId`	The id of the activity. TYPE: `int`
`text`	The text of the activity. TYPE: `str`
`likeCount`	The count of likes on the activity. TYPE: `int`
`isLiked`	Whether the activity is liked by the user. TYPE: `bool`
`createdAt`	The timestamp when the activity was created. TYPE: `int`
`user`	The user who created the activity. TYPE: `BasicUser`
`likes`	The list of users who liked the activity. TYPE: `list`

ACTIVITYSCHEMA `module-attribute` ¶

ACTIVITYSCHEMA = '\n  ... on TextActivity {\n    id\n    userId\n    type\n    replyCount\n    text (asHtml: $asHtml)\n    siteUrl\n    isLocked\n    isSubscribed\n    likeCount\n    isLiked\n    isPinned\n    createdAt\n  }\n  ... on ListActivity {\n    id\n    userId\n    type\n    replyCount\n    status\n    progress\n    isLocked\n    isSubscribed\n    likeCount\n    isLiked\n    isPinned\n    siteUrl\n    createdAt\n    media {\n      id\n      title {\n        romaji\n        english\n      }\n    }\n  }\n  ... on MessageActivity {\n    id\n    recipientId\n    messengerId\n    type\n    replyCount\n    message (asHtml: $asHtml)\n    isLocked\n    isSubscribed\n    likeCount\n    isLiked\n    isPrivate\n    siteUrl\n    createdAt\n  }\n'

This is the ActivitySchema for the Anilist API. It defines the structure of the activity data

ATTRIBUTE	DESCRIPTION
`id`	The id of the activity. TYPE: `int`
`userId`	The id of the user who created the activity. TYPE: `int`
`type`	The type of the activity. TYPE: `str`
`replyCount`	The count of replies on the activity. TYPE: `int`
`text`	The text of the activity. TYPE: `str`
`siteUrl`	The site URL of the activity. TYPE: `str`
`isLocked`	Whether the activity is locked. TYPE: `bool`
`isSubscribed`	Whether the user is subscribed to the activity. TYPE: `bool`
`likeCount`	The count of likes on the activity. TYPE: `int`
`isLiked`	Whether the activity is liked by the user. TYPE: `bool`
`isPinned`	Whether the activity is pinned. TYPE: `bool`
`createdAt`	The timestamp when the activity was created. TYPE: `int`

ACTIVITYSCHEMAV2 `module-attribute` ¶

ACTIVITYSCHEMAV2 = f'
  ... on TextActivity {
    id
    userId
    type
    replyCount
    text (asHtml: $asHtml)
    siteUrl
    isLocked
    isSubscribed
    likeCount
    isLiked
    isPinned
    createdAt
    user {
      {BASICUSERSCHEMA}
    }
    replies {
      {ACTIVITYREPLYSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
  ... on ListActivity {
    id
    userId
    type
    replyCount
    status
    progress
    isLocked
    isSubscribed
    likeCount
    isLiked
    isPinned
    siteUrl
    createdAt
    media {
      id
      title {
        romaji
        english
      }
    }
    user {
      {BASICUSERSCHEMA}
    }
    replies {
      {ACTIVITYREPLYSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
  ... on MessageActivity {
    id
    recipientId
    messengerId
    type
    replyCount
    message (asHtml: $asHtml)
    isLocked
    isSubscribed
    likeCount
    isLiked
    isPrivate
    siteUrl
    createdAt
    recipient {
      {BASICUSERSCHEMA}
    }
    messenger {
      {BASICUSERSCHEMA}
    }
    replies {
      {ACTIVITYREPLYSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
  ... on ActivityReply {
    id
    userId
    activityId
    text (asHtml: $asHtml)
    likeCount
    isLiked
    createdAt
    user {
      {BASICUSERSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
  ... on Thread {
    id
    title
    body (asHtml: $asHtml)
    ThreadUserId: userId
    replyUserId
    replyCommentId
    ThreadReplyCount: replyCount
    viewCount
    isLocked
    isSticky
    isSubscribed
    likeCount
    isLiked
    repliedAt
    createdAt
    updatedAt
    user {
      {BASICUSERSCHEMA}
    }
    replyUser {
      {BASICUSERSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
    siteUrl
    categories {
      id
      name
    }
    mediaCategories {
      id
      {TITLESCHEMA}
    }
  }
  ... on ThreadComment {
    id
    userId
    threadId
    comment (asHtml: $asHtml)
    likeCount
    isLiked
    siteUrl
    createdAt
    updatedAt
    thread {
      id
      title
    }
    user {
      {BASICUSERSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
    childComments
    isLocked
  }
'

This is the ActivitySchemaV2 for the Anilist API. It defines the structure of the activity data

ATTRIBUTE	DESCRIPTION
`id`	The id of the activity. TYPE: `int`
`userId`	The id of the user who created the activity. TYPE: `int`
`type`	The type of the activity. TYPE: `str`
`replyCount`	The count of replies on the activity. TYPE: `int`
`text`	The text of the activity. TYPE: `str`
`siteUrl`	The site URL of the activity. TYPE: `str`
`isLocked`	Whether the activity is locked. TYPE: `bool`
`isSubscribed`	Whether the user is subscribed to the activity. TYPE: `bool`
`likeCount`	The count of likes on the activity. TYPE: `int`
`isLiked`	Whether the activity is liked by the user. TYPE: `bool`
`isPinned`	Whether the activity is pinned. TYPE: `bool`
`createdAt`	The timestamp when the activity was created. TYPE: `int`
`user`	The user who created the activity. TYPE: `BasicUser`
`replies`	The list of replies to the activity. TYPE: `list`
`likes`	The list of users who liked the activity. TYPE: `list`

ACTIVITYWITHREPLIESSCHEMA `module-attribute` ¶

ACTIVITYWITHREPLIESSCHEMA = f'
  ... on TextActivity {
    id
    userId
    type
    replyCount
    text (asHtml: $asHtml)
    siteUrl
    isLocked
    isSubscribed
    likeCount
    isLiked
    isPinned
    createdAt
    user {
      {BASICUSERSCHEMA}
    }
    replies {
      {ACTIVITYREPLYSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
  ... on ListActivity {
    id
    userId
    type
    replyCount
    status
    progress
    isLocked
    isSubscribed
    likeCount
    isLiked
    isPinned
    siteUrl
    createdAt
    media {
      id
      title {
        romaji
        english
      }
    }
    user {
      {BASICUSERSCHEMA}
    }
    replies {
      {ACTIVITYREPLYSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
  ... on MessageActivity {
    id
    recipientId
    messengerId
    type
    replyCount
    message (asHtml: $asHtml)
    isLocked
    isSubscribed
    likeCount
    isLiked
    isPrivate
    siteUrl
    createdAt
    recipient {
      {BASICUSERSCHEMA}
    }
    messenger {
      {BASICUSERSCHEMA}
    }
    replies {
      {ACTIVITYREPLYSCHEMA}
    }
    likes {
      {BASICUSERSCHEMA}
    }
  }
'

This is the ActivityWithRepliesSchema for the Anilist API. It defines the structure of the activity data

ATTRIBUTE	DESCRIPTION
`id`	The id of the activity. TYPE: `int`
`userId`	The id of the user who created the activity. TYPE: `int`
`type`	The type of the activity. TYPE: `str`
`replyCount`	The count of replies on the activity. TYPE: `int`
`text`	The text of the activity. TYPE: `str`
`siteUrl`	The site URL of the activity. TYPE: `str`
`isLocked`	Whether the activity is locked. TYPE: `bool`
`isSubscribed`	Whether the user is subscribed to the activity. TYPE: `bool`
`likeCount`	The count of likes on the activity. TYPE: `int`
`isLiked`	Whether the activity is liked by the user. TYPE: `bool`
`isPinned`	Whether the activity is pinned. TYPE: `bool`
`createdAt`	The timestamp when the activity was created. TYPE: `int`
`user`	The user who created the activity. TYPE: `BasicUser`
`replies`	The list of replies to the activity. TYPE: `list`
`likes`	The list of users who liked the activity. TYPE: `list`

LISTACTIVITYSCHEMA `module-attribute` ¶

LISTACTIVITYSCHEMA = f'
  id
  userId
  type
  replyCount
  status
  progress
  isLocked
  isSubscribed
  likeCount
  isLiked
  isPinned
  siteUrl
  createdAt
  media {
    id
    title {
      romaji
      english
    }
  }
  user {
    {BASICUSERSCHEMA}
  }
  replies {
    {ACTIVITYREPLYSCHEMA}
  }
  likes {
    {BASICUSERSCHEMA}
  }
'

This is the ListActivitySchema for the Anilist API. It defines the structure of the list activity data.

ATTRIBUTE	DESCRIPTION
`id`	The id of the list activity. TYPE: `int`
`userId`	The id of the user who created the list activity. TYPE: `int`
`type`	The type of the list activity. TYPE: `str`
`replyCount`	The count of replies on the list activity. TYPE: `int`
`status`	The status of the list activity. TYPE: `str`
`progress`	The progress of the list activity. TYPE: `int`
`isLocked`	Whether the list activity is locked. TYPE: `bool`
`isSubscribed`	Whether the user is subscribed to the list activity. TYPE: `bool`
`likeCount`	The count of likes on the list activity. TYPE: `int`
`isLiked`	Whether the list activity is liked by the user. TYPE: `bool`
`isPinned`	Whether the list activity is pinned. TYPE: `bool`
`siteUrl`	The site URL of the list activity. TYPE: `str`
`createdAt`	The timestamp when the list activity was created. TYPE: `int`
`media`	The media details of the list activity. TYPE: `dict`
`user`	The user who created the list activity. TYPE: `BasicUser`
`replies`	The list of replies to the list activity. TYPE: `list`
`likes`	The list of users who liked the list activity. TYPE: `list`

MESSAGEACTIVITYSCHEMA `module-attribute` ¶

MESSAGEACTIVITYSCHEMA = f'
  id
  recipientId
  messengerId
  type
  replyCount
  message (asHtml: $asHtml)
  isLocked
  isSubscribed
  likeCount
  isLiked
  isPrivate
  siteUrl
  createdAt
  recipient {
    {BASICUSERSCHEMA}
  }
  messenger {
    {BASICUSERSCHEMA}
  }
  replies {
    {ACTIVITYREPLYSCHEMA}
  }
  likes {
    {BASICUSERSCHEMA}
  }
'

This is the MessageActivitySchema for the Anilist API. It defines the structure of the message activity data.

ATTRIBUTE	DESCRIPTION
`id`	The id of the message activity. TYPE: `int`
`recipientId`	The id of the recipient of the message activity. TYPE: `int`
`messengerId`	The id of the messenger of the message activity. TYPE: `int`
`type`	The type of the message activity. TYPE: `str`
`replyCount`	The count of replies on the message activity. TYPE: `int`
`message`	The message of the message activity. TYPE: `str`
`isLocked`	Whether the message activity is locked. TYPE: `bool`
`isSubscribed`	Whether the user is subscribed to the message activity. TYPE: `bool`
`likeCount`	The count of likes on the message activity. TYPE: `int`
`isLiked`	Whether the message activity is liked by the user. TYPE: `bool`
`isPrivate`	Whether the message activity is private. TYPE: `bool`
`siteUrl`	The site URL of the message activity. TYPE: `str`
`createdAt`	The timestamp when the message activity was created. TYPE: `int`
`recipient`	The recipient of the message activity. TYPE: `BasicUser`
`messenger`	The messenger of the message activity. TYPE: `BasicUser`
`replies`	The list of replies to the message activity. TYPE: `list`
`likes`	The list of users who liked the message activity. TYPE: `list`

TEXTACTIVITYSCHEMA `module-attribute` ¶

TEXTACTIVITYSCHEMA = f'
  id
  userId
  type
  replyCount
  text (asHtml: $asHtml)
  siteUrl
  isLocked
  isSubscribed
  likeCount
  isLiked
  isPinned
  createdAt
  user {
    {BASICUSERSCHEMA}
  }
  replies {
    {ACTIVITYREPLYSCHEMA}
  }
  likes {
    {BASICUSERSCHEMA}
  }
'

This is the TextActivitySchema for the Anilist API. It defines the structure of the text activity data.

ATTRIBUTE	DESCRIPTION
`id`	The id of the text activity. TYPE: `int`
`userId`	The id of the user who created the text activity. TYPE: `int`
`type`	The type of the text activity. TYPE: `str`
`replyCount`	The count of replies on the text activity. TYPE: `int`
`text`	The text of the text activity. TYPE: `str`
`siteUrl`	The site URL of the text activity. TYPE: `str`
`isLocked`	Whether the text activity is locked. TYPE: `bool`
`isSubscribed`	Whether the user is subscribed to the text activity. TYPE: `bool`
`likeCount`	The count of likes on the text activity. TYPE: `int`
`isLiked`	Whether the text activity is liked by the user. TYPE: `bool`
`isPinned`	Whether the text activity is pinned. TYPE: `bool`
`createdAt`	The timestamp when the text activity was created. TYPE: `int`
`user`	The user who created the text activity. TYPE: `BasicUser`
`replies`	The list of replies to the text activity. TYPE: `list`
`likes`	The list of users who liked the text activity. TYPE: `list`

Basic Schema's¶

BASICCOMMENTSCHEMA `module-attribute` ¶

BASICCOMMENTSCHEMA = '\n  id\n  userId\n  threadId\n'

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

ATTRIBUTE	DESCRIPTION
`id`	The id of the comment. TYPE: `int`
`userId`	The id of the user who made the comment. TYPE: `int`
`threadId`	The id of the thread where the comment is. TYPE: `int`

BASICTHREADSCHEMA `module-attribute` ¶

BASICTHREADSCHEMA = '\n  id\n  title\n  body (asHtml: $asHtml)\n  siteUrl\n'

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

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`
`siteUrl`	The site URL of the thread. TYPE: `str`

BASICUSERSCHEMA `module-attribute` ¶

BASICUSERSCHEMA = '\n  id\n  name\n  avatar {\n    large\n  }\n'

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

ATTRIBUTE	DESCRIPTION
`id`	The id of the user. TYPE: `int`
`name`	The name of the user. TYPE: `str`
`avatar`	The avatar of the user with a large size. TYPE: `dict`

CoverImage Schema¶

COVERIMAGESCHEMA `module-attribute` ¶

COVERIMAGESCHEMA = '\ncoverImage {\n  extraLarge\n  large\n  medium\n}\n'

This is the CoverImageSchema for the Anilist API. It defines the structure of the cover image data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`extraLarge`	The URL of the extra large cover image. TYPE: `str`
`large`	The URL of the large cover image. TYPE: `str`
`medium`	The URL of the medium cover image. TYPE: `str`

Distribution Schema¶

SCOREDISTRIBUTIONSCHEMA `module-attribute` ¶

SCOREDISTRIBUTIONSCHEMA = '\n  scoreDistribution {\n    score\n    amount\n  }\n'

This is the DistributionSchema for the AniList API. It defines the structure of the distribution data that is expected to be

ATTRIBUTE	DESCRIPTION
`score`	The score of the distribution. TYPE: `int`
`amount`	The amount of the distribution. TYPE: `int`

STATUSDISTRIBUTIONSCHEMA `module-attribute` ¶

STATUSDISTRIBUTIONSCHEMA = '\n  statusDistribution {\n    status\n    amount\n  }\n'

This is the DistributionSchema for the AniList API. It defines the structure of the distribution data that is expected to be

ATTRIBUTE	DESCRIPTION
`status`	The status of the distribution. TYPE: `str`
`amount`	The amount of the distribution. TYPE: `int`

ExternalLink Schema¶

EXTERNALLINKSCHEMA `module-attribute` ¶

EXTERNALLINKSCHEMA = '\n  externalLinks {\n    id\n    url\n    site\n  }\n'

This is the ExternalLinkSchema for the AniList API. It defines the structure of the external link data that is expected to be

ATTRIBUTE	DESCRIPTION
`id`	The id of the external link. TYPE: `int`
`url`	The url of the external link. TYPE: `str`
`site`	The site of the external link. TYPE: `str`

FuzzyDate Schema¶

FUZZYDATESCHEMA `module-attribute` ¶

FUZZYDATESCHEMA = '\n  year\n  month\n  day\n'

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

ATTRIBUTE	DESCRIPTION
`year`	The year of the date. TYPE: `int`
`month`	The month of the date. TYPE: `int`
`day`	The day of the date. TYPE: `int`

Image Schema¶

IMAGESCHEMA `module-attribute` ¶

IMAGESCHEMA = '\nimage {\n  large\n  medium\n}\n'

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

ATTRIBUTE	DESCRIPTION
`large`	The URL of the large image. TYPE: `str`
`medium`	The URL of the medium image. TYPE: `str`

MediaListEntry Schema¶

MEDIALISTENTRYSCHEMA `module-attribute` ¶

MEDIALISTENTRYSCHEMA = '\n  mediaListEntry {\n    id\n    status\n  }\n'

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

ATTRIBUTE	DESCRIPTION
`id`	The id of the media list entry. TYPE: `int`
`status`	The status of the media list entry. TYPE: `str`

Name Schema¶

NAMESCHEMA `module-attribute` ¶

NAMESCHEMA = '\nname {\nfirst\nlast\nfull\nnative\n}\n'

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

ATTRIBUTE	DESCRIPTION
`first`	The user's first name. TYPE: `str`
`last`	The user's last name. TYPE: `str`
`full`	The user's full name. TYPE: `str`
`native`	The user's name in their native language. TYPE: `str`

NextAiringEpisode Schema¶

NEXTAIRINGEPISODESCHEMA `module-attribute` ¶

NEXTAIRINGEPISODESCHEMA = '\n  nextAiringEpisode {\n    airingAt\n    timeUntilAiring\n    episode\n  }\n'

This is the NextAiringEpisodeSchema for the AniList API. It defines the structure of the next airing episode data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`airingAt`	The airing time of the episode. TYPE: `int`
`timeUntilAiring`	The time until the episode airs. TYPE: `int`
`episode`	The episode number. TYPE: `int`

Notification Schema¶

THREADNOTIFICATIONSCHEMA `module-attribute` ¶

THREADNOTIFICATIONSCHEMA = f'
  id
  userId
  type
  commentId
  context
  createdAt
  thread {
    {BASICTHREADSCHEMA}
  }
  comment {
    {BASICCOMMENTSCHEMA}
  }
  user {
    {BASICUSERSCHEMA}
  }
'

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

ATTRIBUTE	DESCRIPTION
`id`	The id of the thread notification. TYPE: `int`
`userId`	The user id associated with the thread notification. TYPE: `int`
`type`	The type of the thread notification. TYPE: `str`
`commentId`	The comment id associated with the thread notification. TYPE: `int`
`context`	The context of the thread notification. TYPE: `str`
`createdAt`	The creation time of the thread notification. TYPE: `str`
`thread`	The thread associated with the thread notification. TYPE: `str`
`comment`	The comment associated with the thread notification. TYPE: `str`
`user`	The user associated with the thread notification. TYPE: `str`

Ranking Schema¶

RANKINGSCHEMA `module-attribute` ¶

RANKINGSCHEMA = '\n  rankings {\n    id\n    rank\n    type\n    format\n    year\n    season\n    allTime\n    context\n  }\n'

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

ATTRIBUTE	DESCRIPTION
`id`	The id of the ranking. TYPE: `int`
`rank`	The rank of the ranking. TYPE: `int`
`type`	The type of the ranking. TYPE: `str`
`format`	The format of the ranking. TYPE: `str`
`year`	The year of the ranking. TYPE: `int`
`season`	The season of the ranking. TYPE: `str`
`allTime`	The all-time status of the ranking. TYPE: `bool`
`context`	The context of the ranking. TYPE: `str`

SiteTrend Schema¶

SITETRENDCONNECTIONSCHEMA `module-attribute` ¶

SITETRENDCONNECTIONSCHEMA = f'
  pageInfo {
    total
    perPage
    currentPage
    lastPage
    hasNextPage
  }
  edges {
    node {
      {SITETRENDSCHEMA}
    }
  }
  nodes {
    {SITETRENDSCHEMA}
  }
'

This is the SiteTrendConnectionSchema for the AniList API. It defines the structure of the site trend connection data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`pageInfo`	The page information. TYPE: `dict`
`edges`	The edges of the site trend connection. TYPE: `dict`
`nodes`	The nodes of the site trend connection. TYPE: `dict`

SITETRENDSCHEMA `module-attribute` ¶

SITETRENDSCHEMA = '\n  date\n  count\n  change\n'

This is the SiteTrendSchema for the AniList API. It defines the structure of the site trend data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`date`	The date of the site trend. TYPE: `int`
`count`	The count of the site trend. TYPE: `int`
`change`	The change of the site trend. TYPE: `int`

StreamingEpisode Schema¶

STREAMINGEPISODESCHEMA `module-attribute` ¶

STREAMINGEPISODESCHEMA = '\n  streamingEpisodes {\n    title\n    thumbnail\n    url\n    site\n  }\n'

This is the StreamingEpisodeSchema for the AniList API. It defines the structure of the streaming episode data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`title`	The title of the streaming episode. TYPE: `str`
`thumbnail`	The thumbnail of the streaming episode. TYPE: `str`
`url`	The url of the streaming episode. TYPE: `str`
`site`	The site of the streaming episode. TYPE: `str`

Tag Schema¶

TAGSCHEMA `module-attribute` ¶

TAGSCHEMA = '\nid\nname\ndescription\ncategory\nrank\nisGeneralSpoiler\nisMediaSpoiler\nisAdult\nuserId\n'

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

ATTRIBUTE	DESCRIPTION
`id`	The tag's ID. TYPE: `int`
`name`	The tag's name. TYPE: `str`
`description`	The tag's description. TYPE: `str`
`category`	The tag's category. TYPE: `str`
`rank`	The tag's rank. TYPE: `int`
`isGeneralSpoiler`	Whether the tag is a general spoiler. TYPE: `bool`
`isMediaSpoiler`	Whether the tag is a media spoiler. TYPE: `bool`
`isAdult`	Whether the tag is adult. TYPE: `bool`
`userId`	The user's ID. TYPE: `int`

Title Schema¶

TITLESCHEMA `module-attribute` ¶

TITLESCHEMA = '\ntitle {\n  romaji\n  english\n  native\n  userPreferred\n}\n'

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

ATTRIBUTE	DESCRIPTION
`romaji`	The title in romaji. TYPE: `str`
`english`	The title in English. TYPE: `str`
`native`	The title in the native language. TYPE: `str`
`userPreferred`	The user's preferred title. TYPE: `str`

Trailer Schema¶

TRAILERSCHEMA `module-attribute` ¶

TRAILERSCHEMA = '\n  trailer {\n    id\n    site\n    thumbnail\n  }\n'

Trailer schema for AniList GraphQL API

ATTRIBUTE	DESCRIPTION
`id`	The ID of the trailer. TYPE: `str`
`site`	The site of the trailer. TYPE: `str`
`thumbnail`	The thumbnail of the trailer. TYPE: `str`

UserStats Schema¶

USERANIMESTATSSCHEMA `module-attribute` ¶

USERANIMESTATSSCHEMA = '\ncount\nmeanScore\nminutesWatched\nmediaIds\n'

This is the UserAnimeStatsSchema for the Anilist API. It defines the structure of the user's anime statistics data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`count`	The count of anime the user has watched. TYPE: `int`
`meanScore`	The mean score of the anime the user has watched. TYPE: `float`
`minutesWatched`	The total minutes the user has watched anime. TYPE: `int`
`mediaIds`	The list of IDs of the anime the user has watched. TYPE: `list`

USERMANGASTATSSCHEMA `module-attribute` ¶

USERMANGASTATSSCHEMA = '\ncount\nmeanScore\nchaptersRead\nmediaIds\n'

This is the UserMangaStatsSchema for the Anilist API. It defines the structure of the user's manga statistics data that is expected to be returned from the API.

ATTRIBUTE	DESCRIPTION
`count`	The count of manga the user has read. TYPE: `int`
`meanScore`	The mean score of the manga the user has read. TYPE: `float`
`chaptersRead`	The total chapters the user has read in manga. TYPE: `int`
`mediaIds`	The list of IDs of the manga the user has read. TYPE: `list`

Basic Schema Documentation¶

Activity Schema¶

ACTIVITYNOTIFICATIONSCHEMA module-attribute ¶

ACTIVITYREPLYSCHEMA module-attribute ¶

ACTIVITYSCHEMA module-attribute ¶

ACTIVITYSCHEMAV2 module-attribute ¶

ACTIVITYWITHREPLIESSCHEMA module-attribute ¶

LISTACTIVITYSCHEMA module-attribute ¶

MESSAGEACTIVITYSCHEMA module-attribute ¶

TEXTACTIVITYSCHEMA module-attribute ¶

Basic Schema's¶

BASICCOMMENTSCHEMA module-attribute ¶

BASICTHREADSCHEMA module-attribute ¶

BASICUSERSCHEMA module-attribute ¶