<!-- markdownlint-disable MD028 MD033 --> <!-- omit in toc -->

nattadasu's AnimeAPI RESTful API

AnimeAPI (also known as aniApi) is a RESTful API that provides anime relation mapping across multiple anime databases. It mainly focuses on providing relations between anime titles from different databases.

This project was derived on [anime-offline-database][aod] by [manami-project][mp] and [arm] by [kawaiioverflow][ko], while adding support for more databases.

This project is primarily licensed under AGPL-3.0-only, unless otherwise stated. Please read more information regarding using the API on your project in Why avoid using AnimeAPI?.

<!-- omit in toc -->

Table of Contents

<details> <summary>Click to expand</summary>

• Why use AnimeAPI?
• Why Avoid Using AnimeAPI?
• Featured on
  • Libraries
  • Projects, Apps, and Websites
• Supported Platforms and Aliases
• Statistic
• Usage
  • Response Headers
  • Get status and statistics
  • Get latency report
  • Get updated date and time
  • Get all items in Array (Master Array)
  • Fetch all item as TSV (Tab Separated Values) file
  • Get anime relation mapping data
    • Provider exclusive rules
      • Kitsu
      • Letterboxd
      • SIMKL
      • Shikimori
      • The Movie DB
      • The TVDB
      • Trakt
  • Redirect to provider's page
    • Redirect: Parameters
    • Redirect: Response
      • Recommended/verbose path format
      • Short/aliased/alternative path format
      • Provider with slash (/) in mediaid
      • Raw path format
• Schema
  • JSON Schema
  • TypeScript
  • Python Dataclass
• Acknowledgements

</details>

Why use AnimeAPI?

Compared to other relation mapping API, AnimeAPI provides more databases yet it's still easy to use. It also provides more data than other relation mapping API, such as the anime title itself.

Also, AnimeAPI uses object/dictionary format instead of array/list for each provider when you want to get individual relation mapping data. This makes it easier and faster to get the data you want since the machine doesn't need to iterate through the array/list to get the data you want, although with the cost of larger repository size.

Below is the comparison between AnimeAPI and other relation mapping API.

<!-- markdownlint-disable MD013 MD060 -->

| Highlights | AnimeAPI | [ARM][arm] | [BQA][bq] | [Hato][hato] | [SIMKL][smk] | [Trakt][trk] | [Letterboxd][lbx] | [AOD][aod] | [FAL][fal] | [ALAL][alal] | [ATIP][atip] | | ------------------------------- | ---------------------------------------------------------------- | --------------------------- | ------------------ | ------------------------- | ----------------------- | ------------ | ----------------- | ------------------------------------------------------------------- | ------------- | -------------------------------------- | ---------------- | | License | AGPL-3.0-only, MIT, CC0 | MIT | AGPL-3.0 | Apache-2.0 | Proprietary | Proprietary | Proprietary | AGPL-3.0 | Unknown | Unknown | Unknown | | Access | Public | Public | Public | Paid, API Key | API Key | API Key | API Key | Public | Public | Public | Public | | Format | REST, JSON, TSV | Node.js Package, REST, JSON | REST | REST | REST | REST | REST | JSON | JSON | XML | JSON | | Main Languages | Python, JSON | JavaScript, JSON | TypeScript, SQLite | C#, MySQL, PostgreSQL | - | - | - | JSON | JSON | XLSL, XML | PowerShell, JSON | | Base Data | AOD, ARM, ATIP, FAL<br>![f:kz] ![f:oo] ![f:ntj] ![f:hka] ![f:sy] | ![f:ntf] | FAL | ![f:al] ![f:kts] ![f:ntf] | ![f:tvdb] ![f:adb] | ![f:tmdb] | - | ![f:mal] ![f:al] ![f:adb] ![f:kts] ![f:lc] ![f:as] ![f:ap] ![f:ntf] | AOD, ALAL | ![f:adb] ![f:tvdb] ![f:tmdb] ![f:imdb] | [aniTrakt][atrk] | | Rate Limit | - | - | - | - | 1000/day for unverified | 1000/5 mins | 1000/day | Unapplicable | Unapplicable | Unapplicable | Unapplicable | | | | | | | | | | | | | | | Anime Title | ✔ | ❌ | ❌ | ❌ | ✔ | ✔ | ✔ | ✔ | ❌ | ✔ | ✔ | | [![f:adb] aniDB][adb] | ✔ | ❌ | ✔ | ✔ | ✔ | ❌ | ❌ | ✔ | ✔ | ❌ | ❌ | | [![f:al] AniList][al] | ✔ | ✔ | ✔ | ✔ | ✔ Result Only | ❌ | ❌ | ✔ | ✔ | ❌ | ❌ | | [![f:an] ANN][an] | ✔ | ❌ | ❌ | ❌ | ✔ Result Only | ❌ | ❌ | ✔ | ❌ | ❌ | ❌ | | [![f:ap] Anime-Planet][ap] | ✔ | ❌ | ✔ | ❌ | ✔ Result Only | ❌ | ❌ | ✔ | ✔ | ❌ | ❌ | | [![f:as] AniSearch][as] | ✔ | ❌ | ✔ | ❌ | ✔ Result Only | ❌ | ❌ | ✔ | ✔ | ❌ | ❌ | | [![f:ac] Annict][ac] | ✔ | ✔ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | | [![f:hka] Hikka][hka] | ✔ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | | [![f:imdb] IMDB][imdb] | ✔ | ❌ | ✔ | ❌ | ✔ | ✔