malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Transferring API Description file from Apiary.io

Browse Source
This commit is contained in:
Irfan 2019-05-18 06:55:41 +05:00
parent 20f652799d
commit 17a6f93ba0
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
apiary.apib
View File

@ -34,6 +34,10 @@ REST v3.3 has been released!
- Improved/helpful error responses - Improved/helpful error responses
- Bug fixes & improvements - Bug fixes & improvements
# Information
## Links ## Links
- [Jikan.moe](https://jikan.moe) - [Jikan.moe](https://jikan.moe)
- [About](https://jikan.moe/about) - [About](https://jikan.moe/about)
@ -54,8 +58,6 @@ REST v3.3 has been released!
[Add your wrapper here!](https://github.com/jikan-me/jikan-rest/edit/master/apiary.apib) [Add your wrapper here!](https://github.com/jikan-me/jikan-rest/edit/master/apiary.apib)
# Information
## Rate Limiting ## Rate Limiting
Daily Limit: **Unlimited** Daily Limit: **Unlimited**
@ -65,13 +67,13 @@ Daily Limit: **Unlimited**
**Note: Cached requests are NOT throttled** **Note: Cached requests are NOT throttled**
## Bulk Requests ## Bulk Requests
This API serves as a purpose for apps/projects that are user based and make a nominal amount of requests This API serves as a purpose for apps/projects that are user based and make a nominal amount of requests.
⚠️ If you're using thi API for the sake of populating data/making your own database; ⚠️ If you're using the service for the sake of populating data/making your own database;
- You are breaching [MyAnimeList's Terms Of Service](https://myanimelist.net/membership/terms_of_use). **You are responsible.** - You are breaching [MyAnimeList's Terms Of Service](https://myanimelist.net/membership/terms_of_use). **You are responsible for what you're doing.**
- **you MUST to use a delay of 4 (FOUR) SECONDS between each request** - **You MUST use a delay of 4 (FOUR) SECONDS between each request**
- Requesting from multiple isntances is being cheeky and is **NOT** allowed - Requesting from multiple servers/IPs is being cheeky and is **NOT** allowed
- **ABUSE OF THE API WILL RESULT IN AN IP BAN** - **ABUSING THE API WILL RESULT IN GETTING BLOCKED FROM THE SERVICE**
If you're not comfortable being that restrictive, consider setting up your own Jikan REST API - It's super easy. If you're not comfortable being that restrictive, consider setting up your own Jikan REST API - It's super easy.
- [Jikan REST API - GitHub](https://github.com/jikan-me/jikan-rest) - [Jikan REST API - GitHub](https://github.com/jikan-me/jikan-rest)
@ -81,7 +83,7 @@ If you're not comfortable being that restrictive, consider setting up your own J
## Disclaimer ## Disclaimer
- Jikan is not affiliated with MyAnimeList.net - Jikan is not affiliated with MyAnimeList.net
- Jikan is a **free**, open-source API. Use it responsibly! - Jikan is a **free**, open-source API. Use it responsibly!
- **Any abuse of the API will lead to IP bans!**
## JSON Notes ## JSON Notes
- Any property (except arrays) whose value does not exist or is undertermined, will be `null` - Any property (except arrays) whose value does not exist or is undertermined, will be `null`