Git Product home page Git Product logo

anilist-node's Introduction

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 avalible 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 [email protected] or in my Discord server in the #anilist-node channel.

anilist-node's People

Contributors

aurelicbutter avatar axelterizaki avatar bdashore3 avatar exhabition avatar jacob9423 avatar rd-xx avatar salixor avatar totto16 avatar typlox avatar varoop avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.