Members
(constant) ActivitySort :String
- Description:
-
- An enum for activity sorting
- Source:
Properties:
Name | Type | Description |
---|---|---|
ID |
String | |
ID_DESC |
String |
An enum for activity sorting
Type:
- String
(constant) ActivityType :String
- Description:
-
- An enum for activity types
- Source:
Properties:
Name | Type | Description |
---|---|---|
TEXT |
String | |
ANIME_LIST |
String | |
MANGA_LIST |
String | |
MESSAGE |
String | |
MEDIA_LIST |
String |
An enum for activity types
Type:
- String
(constant) EntryStatus :String
- Description:
-
- An enum for list entry status
- Source:
Properties:
Name | Type | Description |
---|---|---|
CURRENT |
String | |
PLANNING |
String | |
COMPLETED |
String | |
DROPPED |
String | |
PAUSED |
String | |
REPEATING |
String |
An enum for list entry status
Type:
- String
(constant) MediaFormat :String
- Description:
-
- An enum for media formats
- Source:
Properties:
Name | Type | Description |
---|---|---|
TV |
String | |
TV_SHORT |
String | |
MOVIE |
String | |
SPECIAL |
String | |
OVA |
String | |
ONA |
String | |
MUSIC |
String | |
MANGA |
String | |
NOVEL |
String | |
ONE_SHOT |
String |
An enum for media formats
Type:
- String
(constant) MediaSeason :String
- Description:
-
- An enum for media seasons
- Source:
Properties:
Name | Type | Description |
---|---|---|
WINTER |
String | |
SPRING |
String | |
SUMMER |
String | |
FALL |
String |
An enum for media seasons
Type:
- String
(constant) MediaSort :String
- Description:
-
- An enum for media sorting
- Source:
Properties:
Name | Type | Description |
---|---|---|
ID |
String | |
ID_DESC |
String | |
TITLE_ROMAJI |
String | |
TITLE_ROMAJI_DESC |
String | |
TITLE_ENGLISH |
String | |
TITLE_ENGLISH_DESC |
String | |
TITLE_NATIVE |
String | |
TITLE_NATIVE_DESC |
String | |
TYPE |
String | |
TYPE_DESC |
String | |
FORMAT |
String | |
FORMAT_DESC |
String | |
START_DATE |
String | |
START_DATE_DESC |
String | |
END_DATE |
String | |
END_DATE_DESC |
String | |
SCORE |
String | |
SCORE_DESC |
String | |
POPULARITY |
String | |
POPULARITY_DESC |
String | |
TRENDING |
String | |
TRENDING_DESC |
String | |
EPISODES |
String | |
EPISODES_DESC |
String | |
DURATION |
String | |
DURATION_DESC |
String | |
STATUS |
String | |
STATUS_DESC |
String | |
CHAPTERS |
String | |
CHAPTERS_DESC |
String | |
VOLUMES |
String | |
VOLUMES_DESC |
String | |
UPDATED_AT |
String | |
UPDATED_AT_DESC |
String | |
SEARCH_MATCH |
String | |
FAVOURITES |
String | |
FAVOURITES_DESC |
String |
An enum for media sorting
Type:
- String
(constant) MediaSource :String
- Description:
-
- An enum for media sources
- Source:
Properties:
Name | Type | Description |
---|---|---|
ORIGINAL |
String | |
MANGA |
String | |
LIGHT_NOVEL |
String | |
VISUAL_NOVEL |
String | |
VIDEO_GAME |
String | |
OTHER |
String | |
NOVEL |
String | |
DOUJINSHI |
String | |
ANIME |
String |
An enum for media sources
Type:
- String
(constant) MediaStatus :String
- Description:
-
- An enum for media statuses
- Source:
Properties:
Name | Type | Description |
---|---|---|
FINISHED |
String | |
RELEASING |
String | |
NOT_YET_RELEASED |
String | |
CANCELLED |
String | |
HIATUS |
String |
An enum for media statuses
Type:
- String
(constant) MediaType :String
- Description:
-
- An enum for media types
- Source:
Properties:
Name | Type | Description |
---|---|---|
ANIME |
String | |
MANGA |
String |
An enum for media types
Type:
- String
(constant) ModRole :String
- Description:
-
- An enum for moderator roles on users
- Source:
Properties:
Name | Type | Description |
---|---|---|
ADMIN |
String | An AniList administrator |
LEAD_DEVELOPER |
String | A head developer of AniList |
DEVELOPER |
String | An AniList developer |
LEAD_COMMUNITY |
String | A lead community moderator |
COMMUNITY |
String | A community moderator |
DISCORD_COMMUNITY |
String | A discord community moderator |
LEAD_ANIME_DATA |
String | A lead anime data moderator |
ANIME_DATA |
String | An anime data moderator |
LEAD_MANGA_DATA |
String | A lead manga data moderator |
MANGA_DATA |
String | A manga data moderator |
LEAD_SOCIAL_MEDIA |
String | A lead social media moderator |
SOCIAL_MEDIA |
String | A social media moderator |
RETIRED |
String | A retired moderator |
An enum for moderator roles on users
Type:
- String
(constant) NotificationType :String
- Description:
-
- An enum for notification types
- Source:
Properties:
Name | Type | Description |
---|---|---|
ACTIVITY_MESSAGE |
String | Recieved a message |
ACTIVITY_REPLY |
String | Replied to user's activity |
FOLLOWING |
String | Another user has followed |
ACTIVITY_MENTION |
String | A user has mentioned you in their activity |
THREAD_COMMENT_MENTION |
String | A user has mentioned you in a forum comment |
THREAD_SUBSCRIBED |
String | A user has commented in one of your subscribed forum threads |
THREAD_COMMENT_REPLY |
String | A user has replied to your forum comment |
AIRING |
String | An anime you are currently watching has aired |
ACTIVITY_LIKE |
String | A user has liked your activity |
ACTIVITY_REPLY_LIKE |
String | A user has liked your activity reply |
THREAD_LIKE |
String | A user has liked your forum thread |
THREAD_COMMENT_LIKE |
String | A user has liked your forum comment |
ACTIVITY_REPLY_SUBSCRIBED |
String | A user has replied to activity you have also replied to |
RELATED_MEDIA_ADDITION |
String | A new anime or manga has been added to the site where its related media is on the user's list |
MEDIA_DATA_CHANGE |
String | An anime or manga has had a data change that affects how a user may track it in their lists |
MEDIA_MERGE |
String | Anime or manga entries on the user's list have been merged into a single entry |
MEDIA_DELETION |
String | An anime or manga on the user's list has been deleted from the site |
An enum for notification types
Type:
- String
(constant) RecommendationRating :String
- Description:
-
- An enum for recommendation ratings
- Source:
Properties:
Name | Type | Description |
---|---|---|
NO_RATING |
String | |
RATE_UP |
String | |
RATE_DOWN |
String |
An enum for recommendation ratings
Type:
- String
(constant) ScoreFormat :String
- Description:
-
- An enum for user scores
- Source:
Properties:
Name | Type | Description |
---|---|---|
POINT_100 |
String | |
POINT_10_DECIMAL |
String | |
POINT_10 |
String | |
POINT_5 |
String | |
POINT_3 |
String |
An enum for user scores
Type:
- String
(constant) UserStaffNameLanguage :String
- Description:
-
- An enum for user name settings
- Source:
Properties:
Name | Type | Description |
---|---|---|
ROMAJI |
String | Person's name in romanized Japanese |
NATIVE |
String | Person's name in native Japanese |
ROMAJI_WESTERN |
String | Similar to Romaji except the names follow Western naming style: Given name, Surname |
An enum for user name settings
Type:
- String
(constant) UserTitleLanguage :String
- Description:
-
- An enum for user title settings
- Source:
Properties:
Name | Type | Description |
---|---|---|
ROMAJI |
String | Media name in romanized Japanese |
ENGLISH |
String | Official media name in English |
NATIVE |
String | Official title in Japanese |
ROMAJI_STYLISED |
String | The romanization of the native language title, stylised by media creator |
ENGLISH_STYLISED |
String | The official english title, stylised by media creator |
NATIVE_STYLISED |
String | Official title in it's native language, stylised by media creator |
An enum for user title settings
Type:
- String
Methods
headerBuilder(queryType, queryTarget, object)
- Description:
-
- Build a query header for query/mutation queries with object values.
- Source:
Parameters:
Name | Type | Description |
---|---|---|
queryType |
String | The type of query (ie: query or mutation) |
queryTarget |
String | What query object is it? (SaveMediaListEntry or Media) |
object |
Object | Object of input values to use in the header. |
Type Definitions
ActivityEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pageInfo |
Object |
Information about the search result page
Properties
|
||||||||||||||||||
activities |
Array.<Object> | Search results | ||||||||||||||||||
id |
Number | The ID of the activity | ||||||||||||||||||
type |
ActivityType | The activity type | ||||||||||||||||||
createdAt |
Number | The creation timestamp of the activity | ||||||||||||||||||
likeCount |
Number | The like count of the activity |
Type:
- Object
ActivityFilterTypes
- Description:
-
- An enum for filter types for values
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The id of the activity |
userId |
Number | The userID of the account with the activity |
messengerId |
Number | The ID of who sent the message |
type |
ActivityType | The type of activity |
isFollowing |
Boolean | [Requires Login] Filter users by who is following the authorized user |
hasReplies |
Boolean | Filter by which activities have replies. |
hasRepliesOrTypeText |
Boolean | Filter by which activities have replies or text |
createdAt |
Number | The time at which the activity was created |
id_not |
Number | Exclude an activity with the given ID |
id_in |
Array.<Number> | Include any activities with the given IDs |
id_not_in |
Array.<Number> | Excludes any activities with the given IDs |
userId_not |
Number | Exclude any activity with the given userID |
userId_in |
Array.<Number> | Includes any activity with the given userIDs |
userId_not_in |
Array.<Number> | Exclude any activity with the given userIDs |
messengerId_not |
Number | Exclude any activity with the given ID |
messengerId_in |
Array.<Number> | Include any activity with the given IDs |
messengerId_not_in |
Array.<Number> | Exclude any activity with the given IDs |
mediaId_not |
Number | Exclude any activity with the given media ID |
mediaId_in |
Array.<Number> | Include any activity with the given media IDs |
mediaId_not_in |
Array.<Number> | Exclude any activity with the given media IDs |
type_not |
ActivityType | Exclude any activity with the same ActivityType |
type_in |
Array.<ActivityType> | Include any activity with the given ActivityTypes |
type_not_in |
Array.<ActivityType> | Exclude any activity with the given ActivityTypes |
createdAt_greater |
Number | Include any activity created at the given date or more recent. |
createdAt_lesser |
Number | Include any activity created at the given date or less recent. |
sort |
Array.<ActivitySort> | Sort the query by the parameters given. |
An enum for filter types for values
AiringEntry
- Source:
Properties:
Name | Type | Description |
---|---|---|
airingAt |
Number | The timestamp that the episode is airing at |
timeUntilAiring |
Number | The amount of seconds until the episode airs |
episode |
Number | The episode number to air. |
Type:
- Object
AniListStats
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
users |
Array.<Object> |
User count over the past seven days
Properties
|
||||||||||||
anime |
Array.<Object> |
Anime count over the past seven days
Properties
|
||||||||||||
manga |
Array.<Object> |
Manga count over the past seven days
Properties
|
||||||||||||
characters |
Array.<Object> |
Character entries over the past seven days
Properties
|
||||||||||||
staff |
Array.<Object> |
Staff entries over the past seven days
Properties
|
||||||||||||
studios |
Array.<Object> |
Studio count over the past seven days
Properties
|
||||||||||||
reviews |
Array.<Object> |
Review count over the past seven days
Properties
|
AnimeEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
airingSchedule |
Array.<AiringEntry> | The media's airing schedule, ordered by episode number (ie: 1, 2, 3, etc...). | ||||||||||||||||||
autoCreateForumThread |
Boolean | Checks if the media gets a thread automatically with each release | ||||||||||||||||||
averageScore |
Number | A weighted average score of the media. | ||||||||||||||||||
bannerImage |
String | The media's banner image | ||||||||||||||||||
characters |
Array.<PersonRelation> | An array of characters | ||||||||||||||||||
countryOfOrigin |
String | The country origin of the media | ||||||||||||||||||
coverImage |
Array.<Object> |
The media's cover image
Properties
|
||||||||||||||||||
description |
String | The medias description | ||||||||||||||||||
duration |
Number | General length of an episode | ||||||||||||||||||
endDate |
FuzzyDateObj | Official end date of the media | ||||||||||||||||||
episodes |
Number | Number of episodes | ||||||||||||||||||
externalLinks |
Array.<String> | A list of external links associated with the media | ||||||||||||||||||
favourites |
Number | Number of users who have favourited it. | ||||||||||||||||||
format |
String | The format of the anime. (ie: TV, OVA, etc...) | ||||||||||||||||||
genres |
Array.<String> | The media's genres | ||||||||||||||||||
hashtag |
String | Twitter hashtag associated with the anime | ||||||||||||||||||
id |
Number | The anime's AniList ID | ||||||||||||||||||
idMal |
Number | The anime's MyAnimeList ID | ||||||||||||||||||
isAdult |
Boolean | Check if the media is for adult audiences (ie: Hentai) | ||||||||||||||||||
isFavourite |
Boolean | [Requires Login] Check if the media is favourited | ||||||||||||||||||
isLicensed |
Boolean | Check if the media is licensed | ||||||||||||||||||
isLocked |
Boolean | Check if the media is locked for list additions or favouriting. | ||||||||||||||||||
isRecommendationBlocked |
Boolean | Check if the media is locked for recommendations. | ||||||||||||||||||
meanScore |
Number | Mean score of the media | ||||||||||||||||||
mediaListEntry |
Object |
[Requires Login] User's media list entry; required for list edits.
Properties
|
||||||||||||||||||
modNotes |
String | Mod notes for the media | ||||||||||||||||||
nextAiringEpisode |
Array.<AiringEntry> | null | The media's next episode airing schedule. Returns either an AiringEntry object or null depending if there is an episode to air. | ||||||||||||||||||
popularity |
Number | Number of users with the media on their list | ||||||||||||||||||
rankings |
Array.<Object> |
Media rankings in a particular category compared to others.
Properties
|
||||||||||||||||||
recommendations |
Array.<MediaRelation> | Recommendations for the media. | ||||||||||||||||||
relations |
Array.<MediaRelation> | All media that relate to the media. | ||||||||||||||||||
reviews |
Array.<Object> |
An array of reviews.
Properties
|
||||||||||||||||||
season |
String | Season that the anime started airing | ||||||||||||||||||
seasonYear |
Number | The season year that the anime started airing | ||||||||||||||||||
siteUrl |
String | The media's AniList page | ||||||||||||||||||
source |
String | Source type that the media was adapted from | ||||||||||||||||||
staff |
Array.<PersonRelation> | An array of credited staff | ||||||||||||||||||
startDate |
FuzzyDateObj | Official release date of the media | ||||||||||||||||||
stats |
Object |
Statistics on the media
Properties
|
||||||||||||||||||
status |
String | The current status of the media | ||||||||||||||||||
streamingEpisodes |
Array.<Object> |
An ordered array of episodes and where it can be streamed.
Properties
|
||||||||||||||||||
studios |
Array.<Object> |
An array of studios that produced the anime.
Properties
|
||||||||||||||||||
synonyms |
Array.<String> | The media's alternative titles | ||||||||||||||||||
tags |
Array.<Object> |
Tags that describes the media
Properties
|
||||||||||||||||||
title |
MediaTitle | The manga's titles | ||||||||||||||||||
trailer |
String | Object | null | Returns the trailer URL if the trailer is a Youtube or Dailymotion video. Will return an object if it is a video outside of YouTube and Dailymotion or null if no trailer is found. | ||||||||||||||||||
trending |
Number | Number of related activity in the past week. | ||||||||||||||||||
trends |
Array.<Object> |
An array of the media's daily trend status
Properties
|
||||||||||||||||||
updatedAt |
Number | Timestamp of when the page was last updated |
Type:
- Object
CharacterEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The person's ID on AniList | ||||||||||||
name |
CharacterName | The person's name | ||||||||||||
image |
Object |
The person's cover image.
Properties
|
||||||||||||
gender |
string | The character's gender. Could be male, female, non-binary, etc... | ||||||||||||
dateOfBirth |
Object | null |
The character's date of birth
Properties
|
||||||||||||
age |
string | The character's age. Listed as a string as it may contain additional text or ranges. | ||||||||||||
bloodType |
string | The character's blood type | ||||||||||||
description |
String | The person's description | ||||||||||||
isFavourite |
Boolean | [Requires Login] Check if the person is favourited | ||||||||||||
isFavouriteBlocked |
Boolean | True if the user is unable to favourite the entry | ||||||||||||
favourites |
Number | The number of users that have favourited the person | ||||||||||||
media |
Array.<MediaRelation> | All media that the character is in. (Up to the first 25 entries) |
Type:
- Object
CharacterName
- Source:
Properties:
Name | Type | Description |
---|---|---|
english |
String | The person's first and last name in English |
native |
String | The person's name in Japanese |
alternative |
Array.<String> | Any nicknames or titles the person goes by. |
alternativeSpoiler |
Array.<String> | Any nicknames or titles the person goes by but is marked as spoilers |
userPreferred |
String | The user's preferred name language. Defaults to romaji for non-authenticated |
Type:
- Object
CountryCode
- Description:
-
- ISO 3166-1 alpha-2 country code
- Source:
ISO 3166-1 alpha-2 country code
Type:
- Number
FuzzyDateInt
- Description:
-
- 8 digit integer (YYYYMMDD). Unknown dates are represented by 0.
- Source:
8 digit integer (YYYYMMDD). Unknown dates are represented by 0.
Type:
- Number
Example
6 Jan 2021 = 20210106
April 2016 = 20160400
1969 = 19690000
FuzzyDateObj
- Description:
-
- An object that contains the year, month, and date of an item.
- Source:
Properties:
Name | Type | Description |
---|---|---|
year |
Number | null | |
month |
Number | null | |
day |
Number | null |
An object that contains the year, month, and date of an item.
Type:
- Object
InitOptions
- Source:
Properties:
Name | Type | Description |
---|---|---|
timeout |
Number | A number in milliseconds which defines a timeout when making requests |
Type:
- Object
ListActivity
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The id of the activity | ||||||||||||
user |
UserRelation | The user of the activity | ||||||||||||
status |
String | The status of the update | ||||||||||||
type |
String | The activity type | ||||||||||||
progress |
Number | null | Progress of the media | ||||||||||||
media |
MediaRelation | The target media | ||||||||||||
createdAt |
Number | The timestamp of the creation time | ||||||||||||
replies |
Array.<Object> |
The replies for the activity
Properties
|
||||||||||||
isLocked |
Boolean | True if the activity cannot receive replies | ||||||||||||
isSubscribed |
Boolean | [Requires Login] True if the authorized user is subscribed. | ||||||||||||
isLiked |
Boolean | [Requires Login] True if authorized user liked it | ||||||||||||
likes |
Array.<UserRelation> | All users who liked the activity |
Type:
- Object
ListEntry
- Source:
Properties:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
media |
Object |
An object containing various media information
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id |
Number | The AniList list ID for the entry | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status |
String | The user's status ("CURRENT", "PLANNING", "COMPLETED", "PAUSED", "DROPPED", "REPEATING") for that media | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
score |
Number | The user's score for the entry | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
progress |
Number | The user's progress for that entry. (Episode count for anime, chapter count for manga) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
progressVolumes |
Number | The user's volume progress for that media (Manga only) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
repeat |
Number | The amount of times the user rewatched or read the media | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority |
Number | The user's priority status for that media | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
private |
Boolean | [Requires Login] Check if the entry should only be visible to the authenticated user. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notes |
String | The user's notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hiddenFromStatusLists |
Boolean | Checks if the entry should be hidden from non-custom lists | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
advancedScores |
Object | The user's advanced scores for that media (Story, Characters, Visuals, Audio, Enjoyment, …) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dates |
Object |
Dates related to that entry in ISO 8601 format
Properties
|
Type:
- Object
MangaEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
autoCreateForumThread |
Boolean | Checks if the media gets a thread automatically with each release | ||||||||||||||||||
averageScore |
Number | A weighted average score of the media. | ||||||||||||||||||
bannerImage |
String | The media's banner image | ||||||||||||||||||
chapters |
Number | Number of chapters | ||||||||||||||||||
characters |
Array.<PersonRelation> | An array of characters | ||||||||||||||||||
countryOfOrigin |
String | The country origin of the media | ||||||||||||||||||
coverImage |
Array.<Object> |
The media's cover image
Properties
|
||||||||||||||||||
description |
String | The manga's description | ||||||||||||||||||
endDate |
FuzzyDateObj | Official end date of the media | ||||||||||||||||||
externalLinks |
Array.<String> | A list of external links associated with the media | ||||||||||||||||||
favourites |
Number | Number of users who have favourited it. | ||||||||||||||||||
format |
String | The format of the manga. (ie: Manga, Novel, etc...) | ||||||||||||||||||
genres |
Array.<String> | The media's genres | ||||||||||||||||||
id |
Number | The manga's AniList ID | ||||||||||||||||||
idMal |
Number | The manga's MyAnimeList ID | ||||||||||||||||||
isAdult |
Boolean | Check if the media is for adult audiences (ie: Hentai) | ||||||||||||||||||
isFavourite |
Boolean | [Requires Login] Check if the media is favourited | ||||||||||||||||||
isLicensed |
Boolean | Check if the media is licensed | ||||||||||||||||||
isLocked |
Boolean | Check if the media is locked for list additions or favouriting. | ||||||||||||||||||
isRecommendationBlocked |
Boolean | Check if the media is locked for recommendations. | ||||||||||||||||||
meanScore |
Number | Mean score of the media | ||||||||||||||||||
mediaListEntry |
Object |
[Requires Login] User's media list entry; required for list edits.
Properties
|
||||||||||||||||||
modNotes |
String | Mod notes for the media | ||||||||||||||||||
popularity |
Number | Number of users with the media on their list | ||||||||||||||||||
rankings |
Array.<Object> |
Media rankings in a particular category compared to others.
Properties
|
||||||||||||||||||
recommendations |
Array.<MediaRelation> | Recommendations for the media. | ||||||||||||||||||
relations |
Array.<MediaRelation> | All media that relate to the media. | ||||||||||||||||||
reviews |
Array.<Object> |
An array of reviews.
Properties
|
||||||||||||||||||
siteUrl |
String | The media's AniList page | ||||||||||||||||||
staff |
Array.<PersonRelation> | An array of credited staff | ||||||||||||||||||
startDate |
FuzzyDateObj | Official release date of the media | ||||||||||||||||||
stats |
Object |
Statistics on the media
Properties
|
||||||||||||||||||
status |
String | The current status of the media | ||||||||||||||||||
synonyms |
Array.<String> | The media's alternative titles | ||||||||||||||||||
tags |
Array.<Object> |
Tags that describes the media
Properties
|
||||||||||||||||||
title |
MediaTitle | The manga's titles | ||||||||||||||||||
trending |
Number | Number of related activity in the past week. | ||||||||||||||||||
trends |
Array.<Object> |
An array of the media's daily trend status.
Properties
|
||||||||||||||||||
updatedAt |
Number | Timestamp of when the page was last updated | ||||||||||||||||||
volumes |
Number | Number of volumes |
Type:
- Object
MediaFilterTypes
- Description:
-
- An enum for filter types for values
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The AniList ID |
idMal |
Number | The MAL ID |
startDate |
FuzzyDateInt | The start date |
endDate |
FuzzyDateInt | The end date |
season |
MediaSeason | The season the show aired |
seasonYear |
Number | The year of the season |
type |
MediaType | The media type |
format |
MediaFormat | The format of the media |
status |
MediaStatus | Status of the media |
episodes |
Number | Number of episodes |
duration |
Number | Time for each episode |
chapters |
Number | Number of chapters |
volumes |
Number | Number of volumes |
isAdult |
boolean | True if the media is adult |
genre |
String | A genre |
tag |
String | A tag |
minimumTagRank |
Number | The minimum tag rank |
tagCategory |
String | The category of the tag |
onList |
boolean | [Requires Login] True if the media is on the user's list |
licensedBy |
String | The licensor of the media |
averageScore |
Number | The average score of the media |
popularity |
Number | The popularity of the media |
source |
MediaFormat | The source of the media |
countryOfOrigin |
CountryCode | The country code for the country origin |
search |
String | The search term to use |
id_not |
Number | The id to exclude |
id_in |
Array.<Number> | The ids to include |
id_not_in |
Array.<Number> | The ids to exclude |
idMal_not |
Number | The MAL id to exclude |
idMal_in |
Array.<Number> | The MAL ids to include |
idMal_not_in |
Array.<Number> | The MAL ids to exclude |
startDate_greater |
FuzzyDateInt | Include any media with a start date equal to or past that date |
startDate_lesser |
FuzzyDateInt | Include any media with a start date equal to or before that date |
startDate_like |
String | Include any media with a start date similar to the provided value. |
endDate_greater |
FuzzyDateInt | Include any media with an end date equal to or past that date |
endDate_lesser |
FuzzyDateInt | Include any media with an end date equal to or before that date |
endDate_like |
String | Include any media with an end date similar to the provided value |
format_in |
Array.<MediaFormat> | Include any media with these formats |
format_not |
MediaFormat | Exclude any media with this format |
format_not_in |
Array.<MediaFormat> | Exclude any media with these formats |
status_in |
Array.<MediaStatus> | Include any media with these statuses |
status_not |
MediaStatus | Exclude any media with this status |
status_not_in |
Array.<MediaStatus> | Exclude any media with these statuses |
episodes_greater |
Number | Include any media with an episode count equal to or greater than the value |
episodes_lesser |
Number | Include any media with an episode count less than or equal to the value |
duration_greater |
Number | Include any media with a duration equal to or greater than the value |
duration_lesser |
Number | Include any media with a duration less than or equal to the value |
chapters_greater |
Number | Include any media with a chapter count equal to or greater than the value |
chapters_lesser |
Number | Include any media with a chapter count less than or equal to the value |
volumes_greater |
Number | Include any media with a volume count equal to or greater than the value |
volumes_lesser |
Number | Include any media with a volume count less than or equal to the value |
genre_in |
Array.<String> | Include any media with the following genres |
genre_not_in |
Array.<String> | Exclude any media with the following genres |
tag_in |
Array.<String> | Include any media with the following tags |
tag_not_in |
Array.<String> | Exclude any media with the following tags |
tagCategory_in |
Array.<String> | Include any media with the following tag categories |
tagCategory_not_in |
Array.<String> | Exclude any media with the following tag categories |
licensedBy_in |
Array.<String> | Include any media licensed by the following licensors |
averageScore_not |
Number | Exclude any media with an average score provided |
averageScore_greater |
Number | Include any media with an average score equal to or greater than the value |
averageScore_lesser |
Number | Include any media with an average score less than or equal to the value |
popularity_not |
Number | Exclude any media with a popularity count provided |
popularity_greater |
Number | Include any media with a popularity count equal to or greater than the value |
popularity_lesser |
Number | Include any media with a popularity count less than or equal to the value |
source_in |
Array.<MediaSource> | Include any media with the following sources |
sort |
Array.<MediaSort> | Sort the query by the provided MediaSort key. (ie: FAVOURITES will sort the query by the favourites count) |
An enum for filter types for values
MediaListOptions
- Source:
Properties:
Name | Type | Description |
---|---|---|
sectionOrder |
Array.<String> | The order each list should be displayed in. |
splitCompletedSectionByFormat |
Boolean | Check if completed sections should be separate by format. |
customLists |
Array.<String> | The names of the user's custom lists |
advancedScoring |
Array.<String> | The names of the user's advanced scoring sections |
advancedScoringEnabled |
Boolean | Check if advanced scoring is enabled for the user's lists |
MediaListOptionsInput
- Description:
-
- The options input for a user's media lists
- Source:
Properties:
Name | Type | Description |
---|---|---|
sectionOrder |
Array.<String> | The order each list should be displayed in |
splitCompletedSectionByFormat |
Boolean | If the completed sections of the list should be separated by format |
customLists |
Array.<String> | The names of the user's custom lists |
advancedScoring |
Array.<String> | The names of the user's advanced scoring sections |
advancedScoringEnabled |
Boolean | If advanced scoring is enabled |
theme |
String | list theme |
The options input for a user's media lists
MediaRelation
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The media's AniList ID |
title |
MediaTitle | The media's titles |
type |
String | Tells what type of media it is. Returns either ANIME or MANGA |
Type:
- Object
MediaTag
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The ID of the tag |
name |
String | Name of the tag |
description |
String | What the tag is about |
category |
String | The category that the tag belongs to |
isAdult |
Boolean | True if tag is meant for adult content |
MediaTitle
- Source:
Properties:
Name | Type | Description |
---|---|---|
english |
String | The offical English licensed title |
native |
String | The Japanese title in Japanese |
romaji |
String | The Japanese romanized title |
userPreferred |
String | The title as it would be displayed to the user |
Type:
- Object
MessageActivity
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The id of the activity | ||||||||||||
user |
UserRelation | The sender of the activity | ||||||||||||
recipient |
UserRelation | The user receiving the message | ||||||||||||
message |
String | The content of the activity | ||||||||||||
type |
String | The activity type | ||||||||||||
createdAt |
Number | The timestamp of the creation time | ||||||||||||
isPrivate |
Boolean | True if message is private and only viewable to sender and recipients | ||||||||||||
replies |
Object |
The replies for the activity
Properties
|
||||||||||||
isLocked |
Boolean | True if the activity cannot receive replies | ||||||||||||
isSubscribed |
Boolean | [Requires Login] True if the authorized user is subscribed. | ||||||||||||
isLiked |
Boolean | [Requires Login] True if authorized user liked it | ||||||||||||
likes |
Array.<UserRelation> | All users who liked the activity |
Type:
- Object
NotificationOption
- Description:
-
- A user's notification options
- Source:
Properties:
Name | Type | Description |
---|---|---|
type |
NotificationType | The type of notification |
enabled |
Boolean | Enable the notification or disable it |
A user's notification options
PersonName
- Source:
Properties:
Name | Type | Description |
---|---|---|
english |
String | The person's first and last name in English |
native |
String | The person's name in Japanese |
alternative |
Array.<String> | Any nicknames or titles the person goes by. |
Type:
- Object
PersonRelation
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The person's AniList ID |
name |
String | The person's name in English |
Type:
- Object
RecommendationEntry
- Description:
-
- A recommendation for a given media
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | ID of the recommendation |
rating |
Number | User ratings of the recommendation |
userRating |
RecommendationRating | [Requires Login] Rating of the recommendation from the authorized user |
user |
UserRelation | The first user to recommend |
mediaRecommendation |
MediaRelation | The media being recommended. |
A recommendation for a given media
RecommendationList
- Description:
-
- A list of recommendations for a given media
- Source:
Properties:
Name | Type | Description |
---|---|---|
media |
MediaRelation | The given media |
recommendations |
Array.<RecommendationEntry> | The list of recommended medias. |
A list of recommendations for a given media
SearchEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pageInfo |
Object |
Information about the search result page
Properties
|
||||||||||||||||||
media |
Array.<Object> |
Search results
Properties
|
Type:
- Object
SingleRecommendation
- Description:
-
- A recommendation for a given media
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | ID of the recommendation |
rating |
Number | User ratings of the recommendation |
userRating |
RecommendationRating | [Requires Login] Rating of the recommendation from the authorized user |
user |
UserRelation | The first user to recommend |
mediaRecommendation |
MediaRelation | The media being recommended. |
media |
MediaRelation | The given media |
A recommendation for a given media
StaffEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The person's ID on AniList | ||||||||||||
name |
StaffName | The person's name | ||||||||||||
image |
Object |
The person's cover image.
Properties
|
||||||||||||
description |
String | The person's description | ||||||||||||
primaryOccupations |
Array.<string> | The primary occupations that the person does | ||||||||||||
gender |
string | The person's gender | ||||||||||||
dateOfBirth |
Object | null |
The person's date of birth
Properties
|
||||||||||||
dateOfDeath |
Object | null |
The person's date of death
Properties
|
||||||||||||
age |
number | The person's age | ||||||||||||
yearsActive |
Array.<number> | Read as (start, end). If only one year is availible, person is still active. | ||||||||||||
homeTown |
string | Where the person is from | ||||||||||||
bloodType |
string | The person's blood type | ||||||||||||
isFavourite |
Boolean | [Requires Login] Check if the person is favourited | ||||||||||||
isFavouriteBlocked |
Boolean | True if user is not allowed to favourite the person | ||||||||||||
favourites |
Number | The number of users that have favourited the person | ||||||||||||
language |
String | The staff's language | ||||||||||||
staffMedia |
Array.<MediaRelation> | An array of ids and titles of all media that the staff has been apart of. (Up to the first 25 entries) | ||||||||||||
characters |
Array.<PersonRelation> | An array of ids and the english names of all characters that the staff has voiced. (Up to the first 25 entries) | ||||||||||||
characterMedia |
Array.<MediaRelation> | An array of ids and titles of all media that the person voiced characters in. (Up to the first 25 entries) |
Type:
- Object
StaffName
- Source:
Properties:
Name | Type | Description |
---|---|---|
english |
String | The person's first and last name in English |
native |
String | The person's name in Japanese |
alternative |
Array.<String> | Any nicknames or titles the person goes by. |
userPreferred |
String | The user's preferred name language. Defaults to romaji for non-authenticated |
Type:
- Object
StudioEntry
- Source:
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The studio's ID | |||||||||
name |
String | The studio's name | |||||||||
isAnimationStudio |
Boolean | Check if the studio is an animation studio | |||||||||
favourites |
Number | Number of users who have favourited it. | |||||||||
media |
Array.<Object> |
A list of all the media the studio has done (Up to the first 25 per AniList's
limit).
Properties
|
|||||||||
siteUrl |
String | The studio's site URL | |||||||||
isFavourite |
Boolean | [Requires Login] Check if the studio is favourited by the user. |
Type:
- Object
TextActivity
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The id of the activity | ||||||||||||
user |
UserRelation | The user of the activity | ||||||||||||
text |
String | The content of the activity | ||||||||||||
type |
String | The activity type | ||||||||||||
createdAt |
Number | The timestamp of the creation time | ||||||||||||
replies |
Object |
The replies for the activity
Properties
|
||||||||||||
isLocked |
Boolean | True if the activity cannot receive replies | ||||||||||||
isSubscribed |
Boolean | [Requires Login] True if the authorized user is subscribed. | ||||||||||||
isLiked |
Boolean | [Requires Login] True if authorized user liked it | ||||||||||||
likes |
Array.<UserRelation> | All users who liked the activity |
Type:
- Object
ThreadComment
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The ID of the thread comment |
user |
UserRelation | The author of the comment |
comment |
String | The content of the comment |
isLiked |
Boolean | [Requires Login] True if current user liked |
createdAt |
Number | The timestamp it was created at |
updatedAt |
Number | The timestamp it was updated at |
likes |
Array.<UserRelation> | An array of users who liked the post |
childComments |
Array.<ThreadComment> | Comments in reply to this comment |
isLocked |
Boolean | True if users can no longer interact with comment. |
ThreadEntry
- Source:
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The AniList ID of the thread | |||||||||
title |
String | Title of the thread | |||||||||
body |
String | Contents of the thread | |||||||||
user |
UserRelation | Author of the thread | |||||||||
replyCommentId |
Number | Comment ID of the latest reply | |||||||||
viewCount |
Number | Number of how many people looked at the thread | |||||||||
isLocked |
Boolean | True if locked. Users cannot comment on thread | |||||||||
isSticky |
Boolean | True if sticky. Thread is pinned at the top of the forum | |||||||||
isSubscribed |
Boolean | [Requires Login] True if authorized user is subscribed to thread | |||||||||
replyUser |
UserRelation | Latest user to reply to the thread. | |||||||||
isLiked |
Boolean | [Requires Login] True if the authorized user liked the thread. | |||||||||
repliedAt |
Number | Timestamp of when the thread was last replied at | |||||||||
createdAt |
Number | Timestamp of when the thread was created | |||||||||
updatedAt |
Number | Timestamp of when the thread was last edited | |||||||||
likes |
Array.<UserRelation> | List of all users who liked the thread | |||||||||
categories |
Array.<Object> |
List of all categories the thread is labeled with
Properties
|
|||||||||
mediaCategories |
Array.<MediaRelation> | List of related media entries for the thread |
UpdateEntryOptions
- Source:
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The ID of the list entry | ||||||||||||
mediaId |
Number | The ID of the media to add | ||||||||||||
status |
EntryStatus | The status on the list (ie: WATCHING) | ||||||||||||
score |
Number | The score of the media in the user's chosen scoring method | ||||||||||||
scoreRaw |
Number | The score in 100 point form | ||||||||||||
progress |
Number | The amount of episodes/chapters | ||||||||||||
progressVolumes |
Number | Amount of volumes read by the user | ||||||||||||
repeat |
Number | Amount of repeats | ||||||||||||
priority |
Number | Priority of planning | ||||||||||||
private |
Boolean | True if the entry is visible only to the authorized user | ||||||||||||
notes |
String | Text notes | ||||||||||||
hiddenFromStatusLists |
Boolean | True if entry should be hidden on non-custom lists | ||||||||||||
customLists |
Array.<String> | Array of list names that the entry should be displayed on | ||||||||||||
advancedScores |
Array.<Number> | Array of advanced scores | ||||||||||||
startedAt |
Object |
Starting date
Properties
|
||||||||||||
completedAt |
Object |
Completion date
Properties
|
UpdatedEntry
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The ID of the list entry | ||||||||||||||||||
mediaId |
Number | The ID of the media to add | ||||||||||||||||||
status |
EntryStatus | The status on the list (ie: WATCHING) | ||||||||||||||||||
score |
Number | The score of the media in the user's chosen scoring method | ||||||||||||||||||
scoreRaw |
Number | The score in 100 point form | ||||||||||||||||||
progress |
Number | The amount of episodes/chapters | ||||||||||||||||||
progressVolumes |
Number | null | Amount of volumes read by the user | ||||||||||||||||||
repeat |
Number | Amount of repeats | ||||||||||||||||||
priority |
Number | Priority of planning | ||||||||||||||||||
private |
Boolean | True if the entry is visible only to the authorized user | ||||||||||||||||||
notes |
String | null | Text notes | ||||||||||||||||||
hiddenFromStatusLists |
Boolean | True if entry should be hidden on non-custom lists | ||||||||||||||||||
customLists |
Array.<String> | null | Array of list names that the entry should be displayed on | ||||||||||||||||||
advancedScores |
Object |
Properties
|
||||||||||||||||||
startedAt |
Object |
Starting date
Properties
|
||||||||||||||||||
completedAt |
Object |
Completion date
Properties
|
UserList
- Source:
Properties:
Name | Type | Description |
---|---|---|
name |
String | The user's list name |
isCustomList |
Boolean | Checks if the list is a custom one (not created by default) |
isSplitCompletedList |
Boolean | Checks if the list is a split completed list. (ie: If the user chose to have each media format in a separate list) |
status |
EntryStatus | The user's list status. Returns either "CURRENT", "PLANNING", "COMPLETED", "PAUSED", "DROPPED", "REPEATING" |
entries |
Array.<ListEntry> | A list of entries on this list |
Type:
- Object
UserOptions
- Source:
Properties:
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
about |
String | The user's description | |||||||||||||||||||||||||||
donatorBadge |
String | The user's donator badge highlight color | |||||||||||||||||||||||||||
options |
Object |
General settings
Properties
|
|||||||||||||||||||||||||||
mediaListOptions |
Object |
List settings
Properties
|
UserOptionsInput
- Source:
Properties:
Name | Type | Description |
---|---|---|
about |
String | The user's description |
titleLanguage |
UserTitleLanguage | The user's preferred title language |
displayAdultContent |
Boolean | True if the user wants to display adult content |
airingNotifications |
Boolean | True if the user wants airing notifications |
scoreFormat |
ScoreFormat | The user's score format |
rowOrder |
String | The user's default list order |
profileColor |
String | The user's profile highlight color |
donatorBadge |
String | The user's donator badge highlight color |
notificationOptions |
Array.<NotificationOption> | The user's notification options |
timezone |
String | The user's timezone offset format |
activityMergeTime |
Number | The minutes between activity for them to be merged together. 0 is Never, Above 2 weeks (20160 mins) is always. |
animeListOptions |
MediaListOptionsInput | The user's options for anime lists |
mangaListOptions |
MediaListOptionsInput | The user's options for manga lists |
staffNameLanguage |
UserStaffNameLanguage | The user's preferred way to see staff and characters |
UserProfile
- Source:
Properties:
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Number | The user's ID | |||||||||||||||||||||||||||
name |
String | The user's username | |||||||||||||||||||||||||||
about |
String | The user's about section | |||||||||||||||||||||||||||
avatar |
Object |
The user's avatar
Properties
|
|||||||||||||||||||||||||||
bannerImage |
String | The user's banner image | |||||||||||||||||||||||||||
isFollowing |
Boolean | [Requires Login] Check if the authorized user is following this user | |||||||||||||||||||||||||||
isBlocked |
Boolean | [Requires Login] Check if the authorized user has blocked this user | |||||||||||||||||||||||||||
isFollower |
Boolean | [Requires Login] Check if the user is following the authorized user | |||||||||||||||||||||||||||
bans |
String | Record of the user's bans | |||||||||||||||||||||||||||
options |
Object |
The user's options
Properties
|
|||||||||||||||||||||||||||
mediaListOptions |
Object |
A user's media list settings
Properties
|
|||||||||||||||||||||||||||
favourites |
Object |
An object containing all of the user's favourited entries
Properties
|
|||||||||||||||||||||||||||
unreadNotificationCount |
Number | Number of notifications that aren't read yet | |||||||||||||||||||||||||||
siteUrl |
String | The user's profile link | |||||||||||||||||||||||||||
donatorTier |
Number | The donator tier of the user | |||||||||||||||||||||||||||
donatorBadge |
String | Custom donation badge text | |||||||||||||||||||||||||||
moderatorRoles |
Array.<ModRole> | Check if the user is a moderator. | |||||||||||||||||||||||||||
updatedAt |
Number | Timestamp of the last update for the profile. |
Type:
- Object
UserRelation
- Source:
Properties:
Name | Type | Description |
---|---|---|
id |
Number | The user's ID |
name |
String | The user's name |
Type:
- Object
UserStats
- Source:
Properties:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
anime |
Object |
The user's statistics with anime
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manga |
Object |
The user's statistics with manga
Properties
|
Type:
- Object