node-shikimori-api

node-shikimori-api - Why? Because.

• Документация на русском

Installing

Using npm

npm i node-shikimori-api

Using yarn

yarn add node-shikimori-api

Common Usage

Basics:

const Shikimori = require("node-shikimori-api");
const shiki = new Shikimori();
 
shiki.api.users({ // request to https://shikimori.org/api/users/Syleront
  user_id: "Syleront"
}).then((res) => {
  // some code
});

Authorizing with OAuth2

const Shikimori = require("node-shikimori-api");
const shiki = new Shikimori();
 
shiki.auth.login({
  nickname: "zerotwo",
  password: "qwerty123"
}).then(() => {
  shiki.api.users({ // request to https://shikimori.org/api/users/whoami
    section: "whoami"
  }).then((res) => {
    // returns logged user info
  });
}).catch((err) => {
  // handle errors
});

Address paths

Shikimori uses some parts of the address as parameters (for example, user id)
How to transfer them? Suppose we need to make a request to ../api/users/zerotwo/history, where zerotwo is the user id (https://shikimori.org/api/doc/1.0/users/history)
To do this, do the following:

shiki.api.users({
  section: "history",
  user_id: "zerotwo" // You can also use anime_id or id instead of user_id
}).then((res) => {
  // some code
});

Also, if the method should be sent POST request instead of GET (for example, to send a message)
To do this, use the parameter "method"

shiki.api.messages({
  method: "post",
  message: { // parameters for post request
    body: "Hello!",
    from_id: 123,
    to_id: 456,
    kind: "private"
  }
}).then((res) => {
  // some code
});

V2 api support

shiki.api.user_rates({
  v: 2, // set this parameter for v2 api
  id: 59278511,
  method: "patch",
  user_rate: {
    episodes: 1
  }
}).then((r) => {
  // some code
});

Parameters for request is merged with wrapper parameters
In deep, he's get next parameters if exists: method, user_id, anime_id, id, v
And removes it from request parameters

Custom methods

The module has some of its methods that were implemented by parsing and sniffing traffic to the site

Search

shiki.utils.search({
  query: "k-on",
  type: "animes" // sets by default
}).then((res) => {
  // return a list of animes by this name
});

Available types: animes, mangas, ranobe, characters, people, users
Also, "people" type may take kind params: seyu, producer, mangaka

Example:

shiki.utils.search({
  query: "hayao",
  type: "people",
  kind: "producer"
}).then((res) => {
  // return a list of producers by query
});

Mark history by days

By default, the site's api does not sort the user history, but a function was written that marks array elements by day
This will help you filter/sort the array.

Usage:

shiki.api.users({
  section: "history",
  user_id: "Syleront",
  limit: 100
}).then(shiki.utils.markHistory).then((r) => {
  // some code
})

Default response:

{
  id: 136013914,
  created_at: "2019-03-12T18:37:35.621+03:00",
  description: "Просмотрены 2-й и 3-й эпизоды",
  target: {} //...
}

Marked response:

{
  id: 136013914,
  created_at: "2019-03-12T18:37:35.621+03:00",
  day_mark: "today", // this one
  day_mark_ru: "Сегодня", // and this
  description: "Просмотрены 2-й и 3-й эпизоды",
  target: {} //...
}

day_mark may have next values: today, yesterday, weekly, other