Querying data ​

The query methods are grouped by domain. Every method takes a typed variables object and an optional trailing RequestOptions.

Selecting fields ​

Every query returns the maximal selection by default. Field-aware queries are those whose signature lists a fields option. They accept it in the trailing options to select fields at any nesting depth. The return type includes the requested fields and any always-selected keys. Plain-response queries such as query.markdown and query.viewer have no fields option. They always return their fixed shape:

const slim = await aniLink.anilist.query.media(
    { id: 123 },
    { fields: ["id", "title.romaji", "averageScore"] }
);
// slim: DeepPick<MediaResponse, "id" | "title.romaji" | "averageScore" | "idMal">

See Field selection for the nested path rules, the always-selected id, page and mutation support, and when to use aniLink.anilist.custom() instead.

Media ​

const anime = await aniLink.anilist.query.media({ id: 21, type: "ANIME" });

Characters & staff ​

Studios ​

Users ​

Lists ​

mediaListCollection returns lists nested by status and custom list. Flatten it with flattenMediaListCollection, and walk large collections with paginateChunks.

Taxonomy ​

Activity ​

Community ​

Reviews & recommendations ​

Misc ​

Example with variables ​

const character = await aniLink.anilist.query.character({
    id: 1,
    asHtml: true,
    mediaSort: ["POPULARITY_DESC"],
    mediaPage: 1,
    mediaPerPage: 10,
});

Next steps ​

• Page queries, fetching a single known page.
• Pagination, collecting many pages automatically.
• Query operation reference, variables and response shapes per operation.