AniList page-query operations
The paginated AniList GraphQL query operations, grouped by response domain.
Page queries
anilist.query.page.users
UsersQuery fetches a page of users. Returns a UsersPageResponse with the items and PageInfo.
Signature
users(variables: UsersVariables, options?: RequestOptions): Promise<UsersPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the user. |
name | string | no | a string representing the name of the user. |
isModerator | boolean | no | a boolean representing whether the user is a moderator. |
search | string | no | a string representing the search term. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
animeStatLimit | number | no | a number representing the limit for anime statistics. |
mangaStatLimit | number | no | a number representing the limit for manga statistics. |
animeStatSort | string[] | no | an array of strings representing the sort order for anime statistics. |
mangaStatSort | string[] | no | an array of strings representing the sort order for manga statistics. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
users | UserResponse[] | a list of `UserResponse` entries representing the users. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.users({page: 1, perPage: 10});anilist.query.page.medias
MediasQuery fetches a page of anime/manga. Returns a MediasPageResponse with the items and PageInfo.
Signature
medias(variables: MediasVariables, options?: RequestOptions): Promise<MediasPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the media. |
idMal | number | no | a number representing the MyAnimeList id of the media. |
startDate | number | no | a number representing the start date of the media. |
endDate | number | no | a number representing the end date of the media. |
season | string | no | a string representing the season of the media. |
seasonYear | number | no | a number representing the year of the season of the media. |
type | "ANIME" | "MANGA" | no | a string representing the type of the media. It can be either 'ANIME' or 'MANGA'. |
format | string | no | a string representing the format of the media. |
status | string | no | a string representing the status of the media. |
episodes | number | no | a number representing the number of episodes of the media. |
duration | number | no | a number representing the duration of the media. |
chapters | number | no | a number representing the number of chapters of the media. |
volumes | number | no | a number representing the number of volumes of the media. |
isAdult | boolean | no | a boolean representing whether the media is for adults. |
genre | string | no | a string representing the genre of the media. |
tag | string | no | a string representing the tag of the media. |
minimumTagRank | number | no | a number representing the minimum tag rank of the media. |
tagCategory | string | no | a string representing the category of the tag of the media. |
onList | boolean | no | a boolean representing whether the media is on the list. |
licensedBy | string | no | a string representing who licensed the media. |
licensedById | number | no | a number representing the id of who licensed the media. |
averageScore | number | no | a number representing the average score of the media. |
popularity | number | no | a number representing the popularity of the media. |
source | string | no | a string representing the source of the media. |
countryOfOrigin | string | no | a string representing the country of origin of the media. |
isLicensed | boolean | no | a boolean representing whether the media is licensed. |
search | string | no | a string representing the search term for the media. |
id_not | number | no | a number representing the id of the media that should not be included. |
id_in | number[] | no | an array of numbers representing the ids of the media that should be included. |
id_not_in | number[] | no | an array of numbers representing the ids of the media that should not be included. |
idMal_not | number | no | a number representing the MyAnimeList id of the media that should not be included. |
idMal_in | number[] | no | an array of numbers representing the MyAnimeList ids of the media that should be included. |
idMal_not_in | number[] | no | an array of numbers representing the MyAnimeList ids of the media that should not be included. |
startDate_greater | number | no | a number representing the minimum start date of the media. |
startDate_lesser | number | no | a number representing the maximum start date of the media. |
startDate_like | string | no | a string representing the start date of the media that should be included. |
endDate_greater | number | no | a number representing the minimum end date of the media. |
endDate_lesser | number | no | a number representing the maximum end date of the media. |
endDate_like | string | no | a string representing the end date of the media that should be included. |
format_in | string[] | no | an array of strings representing the formats of the media that should be included. |
format_not | string | no | a string representing the format of the media that should not be included. |
format_not_in | string[] | no | an array of strings representing the formats of the media that should not be included. |
status_in | string[] | no | an array of strings representing the statuses of the media that should be included. |
status_not | string | no | a string representing the status of the media that should not be included. |
status_not_in | string[] | no | an array of strings representing the statuses of the media that should not be included. |
episodes_greater | number | no | a number representing the minimum number of episodes of the media. |
episodes_lesser | number | no | a number representing the maximum number of episodes of the media. |
duration_greater | number | no | a number representing the minimum duration of the media. |
duration_lesser | number | no | a number representing the maximum duration of the media. |
chapters_greater | number | no | a number representing the minimum number of chapters of the media. |
chapters_lesser | number | no | a number representing the maximum number of chapters of the media. |
volumes_greater | number | no | a number representing the minimum number of volumes of the media. |
volumes_lesser | number | no | a number representing the maximum number of volumes of the media. |
genre_in | string[] | no | an array of strings representing the genres of the media that should be included. |
genre_not_in | string[] | no | an array of strings representing the genres of the media that should not be included. |
tag_in | string[] | no | an array of strings representing the tags of the media that should be included. |
tag_not_in | string[] | no | an array of strings representing the tags of the media that should not be included. |
tagCategory_in | string[] | no | an array of strings representing the categories of the tags of the media that should be included. |
tagCategory_not_in | string[] | no | an array of strings representing the categories of the tags of the media that should not be included. |
licensedBy_in | string[] | no | an array of strings representing who licensed the media that should be included. |
licensedById_in | number[] | no | an array of numbers representing the ids of who licensed the media that should be included. |
averageScore_not | number | no | a number representing the average score of the media that should not be included. |
averageScore_greater | number | no | a number representing the minimum average score of the media. |
averageScore_lesser | number | no | a number representing the maximum average score of the media. |
popularity_not | number | no | a number representing the popularity of the media that should not be included. |
popularity_greater | number | no | a number representing the minimum popularity of the media. |
popularity_lesser | number | no | a number representing the maximum popularity of the media. |
source_in | string[] | no | an array of strings representing the sources of the media that should be included. |
sort | string[] | no | an array of strings representing the sorting order of the media. |
asHtml | boolean | no | a boolean representing whether the media should be returned as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
media | MediaResponse[] | a list of `MediaResponse` entries representing the media. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.medias({page: 1, perPage: 10, type: 'ANIME'});anilist.query.page.characters
CharactersQuery fetches a page of characters. Returns a CharactersPageResponse with the items and PageInfo.
Signature
characters(variables: CharactersVariables, options?: RequestOptions): Promise<CharactersPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the character. |
isBirthday | boolean | no | a boolean representing whether it is the character's birthday. |
search | string | no | a string representing the search term. |
id_not | number | no | a number representing the id that should not be included. |
id_in | number[] | no | an array of numbers representing the ids that should be included. |
id_not_in | number[] | no | an array of numbers representing the ids that should not be included. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
mediaSort | string[] | no | an array of strings representing the media sort order. |
mediaOnList | boolean | no | a boolean representing whether the media is on the list. |
mediaPage | number | no | a number representing the media page number. |
mediaPerPage | number | no | a number representing the number of media items per page. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
characters | CharacterResponse[] | a list of `CharacterResponse` entries representing the characters. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.characters({page: 1, perPage: 10});anilist.query.page.staffs
StaffsQuery fetches a page of staff members. Returns a StaffsPageResponse with the items and PageInfo.
Signature
staffs(variables: StaffsVariables, options?: RequestOptions): Promise<StaffsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the staff. |
isBirthday | boolean | no | a boolean representing whether it is the staff's birthday. |
search | string | no | a string representing the search term. |
id_not | number | no | a number representing the id of the staff that should not be included. |
id_in | number[] | no | an array of numbers representing the ids of the staff that should be included. |
id_not_in | number[] | no | an array of numbers representing the ids of the staff that should not be included. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
staffMediaSort | string[] | no | an array of strings representing the sort order for staff media. |
staffMediaType | string | no | a string representing the type of the staff media. |
staffMediaOnList | boolean | no | a boolean representing whether the staff media is on the list. |
staffMediaPage | number | no | a number representing the page number for staff media. |
staffMediaPerPage | number | no | a number representing the number of staff media items per page. |
charactersSort | string[] | no | an array of strings representing the sort order for characters. |
charactersPage | number | no | a number representing the page number for characters. |
charactersPerPage | number | no | a number representing the number of characters per page. |
characterMediaSort | string[] | no | an array of strings representing the sort order for character media. |
characterMediaOnList | boolean | no | a boolean representing whether the character media is on the list. |
characterMediaPage | number | no | a number representing the page number for character media. |
characterMediaPerPage | number | no | a number representing the number of character media items per page. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
staff | StaffResponse[] | a list of `StaffResponse` entries representing the staff. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.staffs({page: 1, perPage: 10});anilist.query.page.studios
StudiosQuery fetches a page of studios. Returns a StudiosPageResponse with the items and PageInfo.
Signature
studios(variables: StudiosVariables, options?: RequestOptions): Promise<StudiosPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the studio. |
search | string | no | a string representing the search term. |
id_not | number | no | a number representing the id of the studio that should not be included. |
id_in | number[] | no | an array of numbers representing the ids of the studios that should be included. |
id_not_in | number[] | no | an array of numbers representing the ids of the studios that should not be included. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
mediaSort | string[] | no | an array of strings representing the sort order for media. |
mediaIsMain | boolean | no | a boolean representing whether the media is main. |
mediaOnList | boolean | no | a boolean representing whether the media is on the list. |
mediaPage | number | no | a number representing the page number for media. |
mediaPerPage | number | no | a number representing the number of media items per page. |
staffMediaSort | string[] | no | an array of strings representing the sort order for staff media. |
staffMediaType | string | no | a string representing the type of the staff media. |
staffMediaOnList | boolean | no | a boolean representing whether the staff media is on the list. |
staffMediaPage | number | no | a number representing the page number for staff media. |
staffMediaPerPage | number | no | a number representing the number of staff media items per page. |
charactersSort | string[] | no | an array of strings representing the sort order for characters. |
charactersPage | number | no | a number representing the page number for characters. |
charactersPerPage | number | no | a number representing the number of characters per page. |
characterMediaSort | string[] | no | an array of strings representing the sort order for character media. |
characterMediaOnList | boolean | no | a boolean representing whether the character media is on the list. |
characterMediaPage | number | no | a number representing the page number for character media. |
characterMediaPerPage | number | no | a number representing the number of character media items per page. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
studios | StudioResponse[] | a list of `StudioResponse` entries representing the studios. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.studios({page: 1, perPage: 10});anilist.query.page.mediaLists
MediaListsQuery fetches a page of media list entries. Returns a MediaListsPageResponse with the items and PageInfo.
Signature
mediaLists(variables: MediaListsVariables, options?: RequestOptions): Promise<MediaListsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the media list. |
userId | number | no | a number representing the id of the user. |
userName | string | no | a string representing the name of the user. |
type | string | no | a string representing the type of the media. |
status | string | no | a string representing the status of the media list. |
mediaId | number | no | a number representing the id of the media. |
isFollowing | boolean | no | a boolean representing whether the user is following the media. |
notes | string | no | a string representing the notes for the media list. |
startedAt | number | no | a number representing the start date of the media list. |
completedAt | number | no | a number representing the completion date of the media list. |
compareWithAuthList | boolean | no | a boolean representing whether to compare with the authenticated list. |
userId_in | number[] | no | an array of numbers representing the user ids that should be included. |
status_in | string[] | no | an array of strings representing the statuses that should be included. |
status_not_in | string[] | no | an array of strings representing the statuses that should not be included. |
status_not | string | no | a string representing the status that should not be included. |
mediaId_in | number[] | no | an array of numbers representing the media ids that should be included. |
mediaId_not_in | number[] | no | an array of numbers representing the media ids that should not be included. |
notes_like | string | no | a string representing the notes that should be included. |
startedAt_greater | number | no | a number representing the minimum start date. |
startedAt_lesser | number | no | a number representing the maximum start date. |
startedAt_like | string | no | a string representing the start date that should be included. |
completedAt_greater | number | no | a number representing the minimum completion date. |
completedAt_lesser | number | no | a number representing the maximum completion date. |
completedAt_like | string | no | a string representing the completion date that should be included. |
sort | string[] | no | an array of strings representing the sort order. |
scoreFormat | string | no | a string representing the score format. |
asArray | boolean | no | a boolean representing whether to return the result as an array. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
mediaList | MediaListResponse[] | a list of `MediaListResponse` entries representing the media list. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.mediaLists({page: 1, perPage: 10, userId: 542244});anilist.query.page.airingSchedules
AiringSchedulesQuery fetches a page of airing schedule entries. Returns an AiringSchedulesPageResponse with the items and PageInfo.
Signature
airingSchedules(variables: AiringSchedulesVariables, options?: RequestOptions): Promise<AiringSchedulesPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the airing schedule. |
mediaId | number | no | a number representing the id of the media associated with the airing schedule. |
episode | number | no | a number representing the episode number of the airing schedule. |
airingAt | number | no | a number representing the airing time of the airing schedule. |
notYetAired | boolean | no | a boolean representing whether the airing schedule has not yet aired. |
id_not | number | no | a number representing the id that should not be included. |
id_in | number[] | no | an array of numbers representing the ids that should be included. |
id_not_in | number[] | no | an array of numbers representing the ids that should not be included. |
mediaId_not | number | no | a number representing the media id that should not be included. |
mediaId_in | number[] | no | an array of numbers representing the media ids that should be included. |
mediaId_not_in | number[] | no | an array of numbers representing the media ids that should not be included. |
episode_not | number | no | a number representing the episode number that should not be included. |
episode_in | number[] | no | an array of numbers representing the episode numbers that should be included. |
episode_not_in | number[] | no | an array of numbers representing the episode numbers that should not be included. |
episode_greater | number | no | a number representing the minimum episode number. |
episode_lesser | number | no | a number representing the maximum episode number. |
airingAt_greater | number | no | a number representing the minimum airing time. |
airingAt_lesser | number | no | a number representing the maximum airing time. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
airingSchedules | AiringScheduleResponse[] | a list of `AiringScheduleResponse` entries representing the airing schedules. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.airingSchedules({page: 1, perPage: 10});anilist.query.page.mediaTrends
MediaTrendsQuery fetches a page of media trend entries. Returns a MediaTrendsPageResponse with the items and PageInfo.
Signature
mediaTrends(variables: MediaTrendsVariables, options?: RequestOptions): Promise<MediaTrendsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
mediaId | number | no | a number representing the id of the media. |
date | number | no | a number representing the date. |
trending | number | no | a number representing the trending score. |
averageScore | number | no | a number representing the average score. |
popularity | number | no | a number representing the popularity score. |
episode | number | no | a number representing the episode number. |
releasing | boolean | no | a boolean representing whether the media is releasing. |
mediaId_not | number | no | a number representing the id of the media that should not be included. |
mediaId_in | number[] | no | an array of numbers representing the ids of the media that should be included. |
mediaId_not_in | number[] | no | an array of numbers representing the ids of the media that should not be included. |
date_greater | number | no | a number representing the minimum date. |
date_lesser | number | no | a number representing the maximum date. |
trending_greater | number | no | a number representing the minimum trending score. |
trending_lesser | number | no | a number representing the maximum trending score. |
trending_not | number | no | a number representing the trending score that should not be included. |
averageScore_greater | number | no | a number representing the minimum average score. |
averageScore_lesser | number | no | a number representing the maximum average score. |
averageScore_not | number | no | a number representing the average score that should not be included. |
popularity_greater | number | no | a number representing the minimum popularity score. |
popularity_lesser | number | no | a number representing the maximum popularity score. |
popularity_not | number | no | a number representing the popularity score that should not be included. |
episode_greater | number | no | a number representing the minimum episode number. |
episode_lesser | number | no | a number representing the maximum episode number. |
episode_not | number | no | a number representing the episode number that should not be included. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
mediaTrends | MediaTrendResponse[] | a list of `MediaTrendResponse` entries representing the media trends. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.mediaTrends({page: 1, perPage: 10, type: 'ANIME'});anilist.query.page.notifications
NotificationsQuery fetches a page of the authenticated user's notifications. Returns a NotificationsPageResponse with the items and PageInfo. Must be authenticated.
Signature
notifications(variables: NotificationsVariables, options?: RequestOptions): Promise<NotificationsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
type | string | no | a string representing the type of the notification. |
resetNotificationCount | boolean | no | a boolean representing whether to reset the notification count. |
type_in | string[] | no | an array of strings representing the types of notifications that should be included. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
notifications | NotificationResponse[] | a list of `NotificationResponse` entries representing the notifications. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.notifications({page: 1, perPage: 10});anilist.query.page.followers
FollowersQuery fetches a page of a user's followers. Returns a FollowersPageResponse with the items and PageInfo.
Signature
followers(variables: FollowersVariables, options?: RequestOptions): Promise<FollowersPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
userId | number | yes | a number representing the id of the user. |
asHtml | boolean | no | a boolean representing whether the response text is returned as HTML. |
sort | string | no | a string representing the sort order. |
animeStatLimit | number | no | a number representing the limit for anime statistics. |
mangaStatLimit | number | no | a number representing the limit for manga statistics. |
animeStatSort | string[] | no | an array of strings representing the sort order for anime statistics. |
mangaStatSort | string[] | no | an array of strings representing the sort order for manga statistics. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
followers | UserResponse[] | a list of `UserResponse` entries representing the followers. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.followers({page: 1, perPage: 10, userId: 542244});anilist.query.page.following
FollowingQuery fetches a single user that the given userId follows. Returns a UserResponse.
Signature
following(variables: FollowingsVariables, options?: RequestOptions): Promise<FollowingsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
userId | number | yes | a number representing the id of the user. |
asHtml | boolean | no | a boolean representing whether the response text is returned as HTML. |
sort | string | no | a string representing the sort order. |
animeStatLimit | number | no | a number representing the limit for anime statistics. |
mangaStatLimit | number | no | a number representing the limit for manga statistics. |
animeStatSort | string[] | no | an array of strings representing the sort order for anime statistics. |
mangaStatSort | string[] | no | an array of strings representing the sort order for manga statistics. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
following | UserResponse[] | a list of `UserResponse` entries representing the following. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.following({userId: 542244});anilist.query.page.activities
ActivitiesQuery fetches a page of activities. Returns an ActivitiesPageResponse with the items and PageInfo.
Signature
activities(variables: ActivitiesVariables, options?: RequestOptions): Promise<ActivitiesPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the activity. |
userId | number | no | a number representing the id of the user. |
messengerId | number | no | a number representing the id of the messenger. |
mediaId | number | no | a number representing the id of the media. |
type | string | no | a string representing the type of the activity. |
isFollowing | boolean | no | a boolean representing whether the user is following. |
hasReplies | boolean | no | a boolean representing whether the activity has replies. |
hasRepliesOrTypeText | boolean | no | a boolean representing whether the activity has replies or type text. |
createdAt | number | no | a number representing the creation time of the activity. |
id_not | number | no | a number representing the id that should not be included. |
id_in | number[] | no | an array of numbers representing the ids that should be included. |
id_not_in | number[] | no | an array of numbers representing the ids that should not be included. |
userId_not | number | no | a number representing the user id that should not be included. |
userId_in | number[] | no | an array of numbers representing the user ids that should be included. |
userId_not_in | number[] | no | an array of numbers representing the user ids that should not be included. |
messengerId_not | number | no | a number representing the messenger id that should not be included. |
messengerId_in | number[] | no | an array of numbers representing the messenger ids that should be included. |
messengerId_not_in | number[] | no | an array of numbers representing the messenger ids that should not be included. |
mediaId_not | number | no | a number representing the media id that should not be included. |
mediaId_in | number[] | no | an array of numbers representing the media ids that should be included. |
mediaId_not_in | number[] | no | an array of numbers representing the media ids that should not be included. |
type_not | string | no | a string representing the type that should not be included. |
type_in | string[] | no | an array of strings representing the types that should be included. |
type_not_in | string[] | no | an array of strings representing the types that should not be included. |
createdAt_greater | number | no | a number representing the minimum creation time. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
activities | Activity[] | a list of `Activity` entries representing the activities. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.activities({page: 1, perPage: 10, userId: 542244});anilist.query.page.activityReplies
ActivityRepliesQuery fetches a page of replies for an activity. Returns an ActivityRepliesPageResponse with the items and PageInfo.
Signature
activityReplies(variables: ActivityRepliesVariables, options?: RequestOptions): Promise<ActivityRepliesPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the activity reply. |
activityId | number | no | a number representing the id of the activity. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
activityReplies | ActivityReply[] | a list of `ActivityReply` entries representing the activity replies. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.activityReplies({page: 1, perPage: 10, activityId: 723235883});anilist.query.page.threads
ThreadsQuery fetches a page of forum threads. Returns a ThreadsPageResponse with the items and PageInfo.
Signature
threads(variables: ThreadsVariables, options?: RequestOptions): Promise<ThreadsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the thread. |
userId | number | no | a number representing the id of the user. |
replyUserId | number | no | a number representing the id of the reply user. |
subscribed | boolean | no | a boolean representing whether the user is subscribed. |
categoryId | number | no | a number representing the id of the category. |
mediaCategoryId | number | no | a number representing the id of the media category. |
search | string | no | a string representing the search term. |
id_in | number[] | no | an array of numbers representing the ids of the threads that should be included. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
threads | ThreadResponse[] | a list of `ThreadResponse` entries representing the threads. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.threads({page: 1, perPage: 10});anilist.query.page.threadComments
ThreadCommentsQuery fetches a page of comments for a thread. Returns a ThreadCommentsPageResponse with the items and PageInfo.
Signature
threadComments(variables: ThreadCommentsVariables, options?: RequestOptions): Promise<ThreadCommentsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the thread comment. |
threadId | number | no | a number representing the id of the thread. |
userId | number | no | a number representing the id of the user. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
threadComments | ThreadCommentResponse[] | a list of `ThreadCommentResponse` entries representing the thread comments. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.threadComments({page: 1, perPage: 10, threadId: 71881});anilist.query.page.reviews
ReviewsQuery fetches a page of reviews. Returns a ReviewsPageResponse with the items and PageInfo.
Signature
reviews(variables: ReviewsVariables, options?: RequestOptions): Promise<ReviewsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the review. |
mediaId | number | no | a number representing the id of the media. |
userId | number | no | a number representing the id of the user. |
mediaType | string | no | a string representing the type of the media. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
reviews | ReviewResponse[] | a list of `ReviewResponse` entries representing the reviews. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.reviews({page: 1, perPage: 10, mediaId: 1});anilist.query.page.recommendations
RecommendationsQuery fetches a page of recommendations. Returns a RecommendationsPageResponse with the items and PageInfo.
Signature
recommendations(variables: RecommendationsVariables, options?: RequestOptions): Promise<RecommendationsPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
id | number | no | a number representing the id of the recommendation. |
mediaId | number | no | a number representing the id of the media. |
mediaRecommendationId | number | no | a number representing the id of the media recommendation. |
userId | number | no | a number representing the id of the user. |
rating | number | no | a number representing the rating of the recommendation. |
onList | boolean | no | a boolean representing whether the recommendation is on the list. |
rating_greater | number | no | a number representing the minimum rating. |
rating_lesser | number | no | a number representing the maximum rating. |
sort | string[] | no | an array of strings representing the sort order. |
asHtml | boolean | no | a boolean representing whether to return the result as HTML. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
recommendations | RecommendationResponse[] | a list of `RecommendationResponse` entries representing the recommendations. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.recommendations({page: 1, perPage: 10, mediaId: 1});anilist.query.page.likes
LikesQuery fetches a page of users who liked a likeable entity. Returns a LikesPageResponse with the items and PageInfo.
Signature
likes(variables: LikesVariables, options?: RequestOptions): Promise<LikesPageResponse>Auth: Not required — public data. Pass a token for viewer-scoped fields.
| Name | Type | Required | Description |
|---|---|---|---|
likeableId | number | no | a number representing the id of the likeable item. |
type | LikeableType | no | a string representing the type of the likeable item. |
page | number | no | a number representing the page number. |
perPage | number | no | a number representing the number of items per page. |
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | The pagination information |
likes | BasicUser[] | a list of `BasicUser` entries representing the likes. |
AniLinkApiError— non-success AniList HTTP responseAniLinkGraphQLError— HTTP 200 response carrying GraphQL errorsAniLinkNetworkError— timeout, cancellation, or transport failure
Example
await aniLink.anilist.query.page.likes({page: 1, perPage: 10, likeAbleId: 1});