Skip to content

Latest commit

 

History

History
111 lines (77 loc) · 5.61 KB

README.MD

File metadata and controls

111 lines (77 loc) · 5.61 KB
Raw

Jikan

Jikan REST API v4 - Unofficial MyAnimeList.net REST API

Average time to resolve an issue Percentage of issues still open stable Discord Server

Jikan is a REST API for MyAnimeList.net. It scrapes the website to satisfy the need for API functionality that MyAnimeList.net lacks.

The raison d'être of Jikan is to assist developers easily get the data they need for their apps and projects without having to depend on unstable APIs, or sidetracking their projects to develop parsers.

The word Jikan literally translates to Time in Japanese (時間). And that's what this API saves you of. ;)

Notice: Jikan REST API does not support authenticated requests. You can not update your lists. Use the official MyAnimeList API for this!

Installation

NOTICE: v3

This is Jikan REST API v4 - which has been merged into master branch. If you're looking for deploying a v3 build, view the v3 branch for installation instructions: https://github.com/jikan-me/jikan-rest/tree/v3

⚠ v3 is discontinued and will no longer receive any updates.

Manual installation

Please read the manual installation guide. For any additional help, join our Discord server.

🐳 Docker Installation

We distribute the app as a container image, so you can just run it:

docker run -d --name=jikan-rest -p 8080:8080 -v ./.env:/app/.env jikanme/jikan-rest:latest

For more information please refer to our container usage guide.

Public REST API

If you don't want to host your instance, there's a public API available.

Documentation

Please view the documentation. For any additional help, join our Discord server.

Wrappers

Language Wrappers
JavaScript JikanJS by Zuritor
🆕 (v4) JikanJS by Mateo Aranda
Java Jikan4java by Doomsdayrs
🆕 (v4) reactive-jikan by Sandro Marques
🆕 (v4) Jaikan by ShindouMihou
Python (v4) JikanPy by Abhinav Kasamsetty
🆕 (v4) jikan4snek by Indrawan I.
Node.js jikan-node by xy137
jikan-nodejs by ribeirogab
🆕 (v4) Jikan4JS by RizzziGit
🆕 (v4) jikan-api.js by OpenianDev
TypeScript jikants by Julien Broyard
jikan-client by Javier Blanco
🆕 (v4) jikan-ts by Clara Castillo
PHP jikan-php by Jan Vernieuwe
.NET 🆕 (v4) Jikan.net by Ervie
Go 🆕 (v4) jikan-go by Daren Liang
jikan2go by nokusukun
Ruby Jikan.rb by Zerocchi
Dart jikan-dart by Rafal Wachol
Kotlin JikanKt by Ganedra Afrasya

Add your wrapper here

Running Tests

php vendor/bin/phpunit tests

Note: Tests may fail due to rate limit from MyAnimeList (HTTP 429)

Backers

A huge thank you to all our Patrons! 🙏 This project wouldn't be running without your support.

We have a free REST API service, if you wish to support us you can become a Patron!

Sugoi (すごい) Patrons

Patrons

  • Aaron Treinish
  • Abdelhafid Achtaou
  • Aika Fujiwara
  • Bobby Williams
  • Cesar Irad Mendoza
  • CrafterSama
  • Fro116
  • Jason Weatherly
  • Jesse
  • Kundan Chintamaneni
  • Kururin
  • Purplepinapples
  • Ryo Ando
  • Sakamotodesu
  • TeraNovaLP

Development
JetBrain Jikan's development is powered by JetBrain's Open Source License

A shoutout to their amazing products and for supporting Jikan since early versions!

DISCLAIMER

  • Jikan is not affiliated with MyAnimeList.net
  • You are responsible for the usage of this API. Please be respectful towards MyAnimeList's Terms Of Service