jikan-rest/README.MD

Jikan - Unofficial MyAnimeList.net REST API

Jikan is a REST API for MyAnimeList.net. It scrapes the website to satisfy the need for some API functionality - that MyAnimeList 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 does not support authenticated requests. You can not update your lists. Use the official MyAnimeList API for this.

Index

• What's new?
• Getting Started
  • Requirements
  • 🐳 Docker
  • Installation Prerequisites
  • Installation
  • Configuration
  • Ignition
  • Configuring Cache Driver (optional)
  • Configuring Cache Method (optional)
  • Configuring Supervisord (optional)
• Troubleshooting
• Artisan Commands
• Information
• Wrappers
• Running Tests
• Backers
• Disclaimer

What's new?

Getting Started

Requirements

• PHP ^7.4
• Composer
• MongoDB

Information

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

• REST DOCUMENTATION
• Apps/Projects using JikanREST

Wrappers

• [.NET] Jikan.net by Ervie
• [Python] JikanPy by Andrew Conant & Abhinav Kasamsetty
• [Ruby] Jikan.rb by Zerocchi
• [JavaScript] JikanJS by Zuritor
• [Java] Jikan4java by Doomsdayrs
• [PHP] jikan-php by Jan Vernieuwe
• [Node.js] jikan-node by xy137
• [Dart] jikan-dart by Rafal Wachol
• [TypeScript] jikants by Julien Broyard
• [TypeScript] jikan-client by Javier Blanco
• [Go] jikan-go by Daren Liang
• [Elixir] JikanEx by Sean Breckenridge

Add your wrapper here

Running Tests

php vendor/bin/phpunit tests

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

---

Backers

Sugoi (すごい) Backers

Thank you to all our Sugoi (すごい) backers! 🙏 [Become a sugoi backer]

• Jared Allard (jaredallard)
• hugonun (hug_onun)

Backers

Thank you to all our backers! 🙏 [Become a backer]

• PurplePinapples
• Barkdoll (Jesse)
• Piotr Szymczak (Drutol)
• Jason Weatherly (jamesthebard)
• Cesar Irad Mendoza (aberuwu)

Sponsors

Thank you to all our sponsors! [Become a sponsor]

• Hibiki Matsujo

---

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