AurelicButter / AniList-Node

A lightweight Node.js wrapper for the AniList API
https://katsurin.com/docs/anilist-node/
MIT License
44 stars 19 forks source link
anilist anilist-api anilist-node api-wrapper javascript

Anilist-Node

Total Downloads (NPM Link) Monthly Downloads (NPM Link) Support Server

A simple, lightweight Node.js wrapper for the AniList API.

Using Anilist-node

To install: npm install anilist-node

You may need a token for some features (ie checking favourites). A token only needs to be generated once in order to use. To start, head to Anilist's Developer Page and click "Create New Client". Note the client id and place this URL into your client redirect https://anilist.co/api/v2/oauth/pin. This URL will allow you to get your token when authorizing. Then, copy paste this URL https://anilist.co/api/v2/oauth/authorize?client_id={clientID}&response_type=token, replacing the {clientID} with your client ID. It will ask you to log in and then provide you with the token to use.

NOTE: Please store your token securely and privately! This gives access to your AniList account. It is your responsibility to maintain your token.

Example

General lookup search (no login):

const anilist = require('anilist-node');
const Anilist = new anilist();

Anilist.media.anime(21708).then(data => {
    console.log(data);
});

Lookup search (login):

const settings = require('./settings.json'); //Or wherever your store your token.
const anilist = require('anilist-node');
const Anilist = new anilist(settings.token /* This being your token */);

Anilist.media.anime(21708).then(data => {
    console.log(data);
});

For a more in-depth guide on getting started, check out our Getting Started guide on our site or on the static HTML site under the docs directory.

Documentation

Documentation is provided in two locations. A static HTML site is available with the package under the docs directory. Or users can view the same site online here: katsurin.com/docs/anilist-node.

Contributing

Please refer to the Contributing Guide for more information.

License and Contact

AniList-Node is licensed under the MIT License.

For issues and bugs, please use the issue tracker on the GitHub repository. For other needs, either contact me by email fkatsura@katsurin.com or in my Discord server in the #anilist-node channel.