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
jikan-rest/storage/api-docs/api-docs.json
Irfan e6d59d926a update docs
2022-02-11 14:33:06 +05:00

6781 lines
276 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"openapi": "3.0.0",
"info": {
"title": "Jikan API",
"description": "[Jikan](https://jikan.moe) is an **Unofficial** MyAnimeList API.\r\nIt scrapes the website to satisfy the need for a complete API - which MyAnimeList lacks.\r\n\r\n# Information\r\n\r\n⚡ Jikan is powered by it's awesome backers - 🙏 [Become a backer](https://www.patreon.com/jikan)\r\n\r\n## Rate Limiting\r\n\r\n| Duration | Requests |\r\n|----|----|\r\n| Monthly | **Unlimited** |\r\n| Per Minute | 60 requests |\r\n| Per Second | 3 requests |\r\n\r\n\r\n## JSON Notes\r\n- Any property (except arrays or objects) whose value does not exist or is undetermined, will be `null`.\r\n- Any array or object property whose value does not exist or is undetermined, will be empty.\r\n- Any `score` property whose value does not exist or is undetermined, will be `0`.\r\n- All dates and timestamps are returned in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format and in UTC timezone\r\n\r\n## Caching\r\nBy **CACHING**, we refer to the data parsed from MyAnimeList which is stored temporarily on our servers to provide better API performance.\r\n\r\nAll requests, by default are cached for **24 hours** except the following endpoints which have their own unique cache **Time To Live**.\r\n\r\n| Request | TTL |\r\n| ---- | ---- |\r\n| All (Default) | 24 hours |\r\n| User Anime/Manga List | 5 minutes |\r\n\r\n\r\nThe following response headers will detail cache information.\r\n\r\n| Header | Remarks |\r\n| ---- | ---- |\r\n| `Expires` | Expiry unix timestamp |\r\n\r\n\r\n## Allowed HTTP(s) requests\r\n\r\n**Jikan REST API does not provide authenticated requests for MyAnimeList.** This means you can not use it to update your anime/manga list.\r\nOnly GET requests are supported which return READ-ONLY data.\r\n\r\n## HTTP Responses\r\n\r\n| HTTP Status | Remarks |\r\n| ---- | ---- |\r\n| `200 - OK` | The request was successful |\r\n| `304 - Not Modified` | You have the latest data (Cache Validation response) |\r\n| `400 - Bad Request` | You've made an invalid request. Recheck documentation |\r\n| `404 - Not Found` | The resource was not found or MyAnimeList responded with a `404` |\r\n| `405 - Method Not Allowed` | Requested Method is not supported for resource. Only `GET` requests are allowed |\r\n| `429 - Too Many Request` | You are being rate limited by Jikan or MyAnimeList is rate-limiting our servers (specified in the error response) |\r\n| `500 - Internal Server Error` | Something is not working on our end. If you see an error response with a `report_url` URL, please click on it to open an auto-generated GitHub issue |\r\n| `503 - Service Unavailable` | The service has broke. |\r\n\r\n\r\n## JSON Error Response\r\n\r\n```json\r\n {\r\n \"status\": 404,\r\n \"type\": \"BadResponseException\",\r\n \"message\": \"Resource does not exist\",\r\n \"error\": \"Something Happened\",\r\n \"report_url\": \"https://github.com...\"\r\n }\r\n```\r\n\r\n| Property | Remarks |\r\n| ---- | ---- |\r\n| `status` | Returned HTTP Status Code |\r\n| `type` | Thrown Exception |\r\n| `message` | Human-readable error message |\r\n| `error` | Error response and trace from the API |\r\n| `report_url` | Clicking this would redirect you to a generated GitHub issue. ℹ It's only returned on a parser error. |\r\n\r\n\r\n## Cache Validation\r\n\r\n- All requests return a `ETag` header which is an MD5 hash of the response\r\n- You can use this hash to verify if there's new or updated content by suppliying it as the value for the `If-None-Match` in your next request header\r\n- You will get a HTTP `304 - Not Modified` response if the content has not changed\r\n- If the content has changed, you'll get a HTTP `200 - OK` response with the updated JSON response\r\n\r\n![Cache Validation](https://i.imgur.com/925ozVn.png 'Cache Validation')\r\n\r\n## Disclaimer\r\n\r\n- Jikan is not affiliated with MyAnimeList.net.\r\n- Jikan is a free, open-source API. Please use it responsibly.\r\n\r\n----\r\n\r\nBy using the API, you are agreeing to Jikan's [terms of use](https://jikan.moe/terms) policy.\r\n\r\n[v3 Documentation](https://jikan.docs.apiary.io/) - [Wrappers/SDKs](https://github.com/jikan-me/jikan#wrappers) - [Report an issue](https://github.com/jikan-me/jikan-rest/issues/new) - [Host your own server](https://github.com/jikan-me/jikan-rest)",
"termsOfService": "https://jikan.moe/terms",
"contact": {
"name": "API Support (Discord)",
"url": "http://discord.jikan.moe"
},
"license": {
"name": "MIT",
"url": "https://github.com/jikan-me/jikan-rest/blob/master/LICENSE"
},
"version": "4.0.0"
},
"servers": [
{
"url": "https://api.jikan.moe/v4",
"description": "Jikan REST API Beta"
}
],
"paths": {
"/anime/{id}": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns anime resource",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/anime"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/characters": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeCharacters",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns anime characters resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime characters"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/staff": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeStaff",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns anime staff resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime staff"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/episodes": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeEpisodes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Returns a list of anime episodes",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime episodes"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/episodes/{episode}": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeEpisodeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "episode",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns a single anime episode resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime episode"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/news": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeNews",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Returns a list of news articles related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime news"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/forum": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeForum",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "topic",
"in": "query",
"description": "Filter topics",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"episode",
"other"
]
}
}
],
"responses": {
"200": {
"description": "Returns a list of forum topics related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/forum"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/videos": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeVideos",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns videos related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime videos"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/pictures": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimePictures",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns pictures related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pictures variants"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/statistics": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeStatistics",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns anime statistics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime statistics"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/moreinfo": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeMoreInfo",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns anime statistics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moreinfo"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/recommendations": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeRecommendations",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns anime recommendations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/entry recommendations"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/userupdates": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeUserUpdates",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns a list of users who have added/updated/removed the entry on their list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime userupdates"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/reviews": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeReviews",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Returns anime reviews",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime reviews"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/relations": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeRelations",
"responses": {
"200": {
"description": "Returns anime relations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/relation"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/themes": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeThemes",
"responses": {
"200": {
"description": "Returns anime themes",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime themes"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/characters/{id}": {
"get": {
"tags": [
"characters"
],
"operationId": "getCharacterById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns character resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/character"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/characters/{id}/anime": {
"get": {
"tags": [
"characters"
],
"operationId": "getCharacterAnime",
"responses": {
"200": {
"description": "Returns anime that character is in",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/character anime"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/characters/{id}/manga": {
"get": {
"tags": [
"characters"
],
"operationId": "getCharacterManga",
"responses": {
"200": {
"description": "Returns manga that character is in",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/character manga"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/characters/{id}/voices": {
"get": {
"tags": [
"characters"
],
"operationId": "getCharacterVoiceActors",
"responses": {
"200": {
"description": "Returns the character's voice actors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/character voice actors"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/characters/{id}/pictures": {
"get": {
"tags": [
"characters"
],
"operationId": "getCharacterPictures",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns pictures related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pictures"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/clubs/{id}": {
"get": {
"tags": [
"clubs"
],
"operationId": "getClubsById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns Club Resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/club"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/clubs/{id}/members": {
"get": {
"tags": [
"clubs"
],
"operationId": "getClubMembers",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Returns Club Members Resource",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"$ref": "#/components/schemas/club member"
}
]
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/clubs/{id}/staff": {
"get": {
"tags": [
"clubs"
],
"operationId": "getClubStaff",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns Club Staff",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/club staff"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/clubs/{id}/relations": {
"get": {
"tags": [
"clubs"
],
"operationId": "getClubRelations",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns Club Relations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/club relations"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/genres/anime": {
"get": {
"tags": [
"genres"
],
"operationId": "getAnimeGenres",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "filter",
"in": "query",
"schema": {
"$ref": "#/components/schemas/genre query filter"
}
}
],
"responses": {
"200": {
"description": "Returns entry genres, explicit_genres, themes and demographics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/genres"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/genres/manga": {
"get": {
"tags": [
"genres"
],
"operationId": "getMangaGenres",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "filter",
"in": "query",
"schema": {
"$ref": "#/components/schemas/genre query filter"
}
}
],
"responses": {
"200": {
"description": "Returns entry genres, explicit_genres, themes and demographics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/genres"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/magazines": {
"get": {
"tags": [
"magazines"
],
"operationId": "getMagazines",
"responses": {
"200": {
"description": "Returns magazines collection",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/magazines"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaById",
"responses": {
"200": {
"description": "Returns pictures related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/characters": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaCharacters",
"responses": {
"200": {
"description": "Returns manga characters resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga characters"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/news": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaNews",
"responses": {
"200": {
"description": "Returns a list of manga news topics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga news"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/forum": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaTopics",
"responses": {
"200": {
"description": "Returns a list of manga forum topics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/forum"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/pictures": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaPictures",
"responses": {
"200": {
"description": "Returns a list of manga forum topics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pictures"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/statistics": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaStatistics",
"responses": {
"200": {
"description": "Returns anime statistics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga statistics"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/moreinfo": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaMoreInfo",
"responses": {
"200": {
"description": "Returns manga moreinfo",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moreinfo"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/recommendations": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaRecommendations",
"responses": {
"200": {
"description": "Returns manga recommendations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/entry recommendations"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/userupdates": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaUserUpdates",
"responses": {
"200": {
"description": "Returns manga user updates",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga userupdates"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/reviews": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaReviews",
"responses": {
"200": {
"description": "Returns manga reviews",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga reviews"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga/{id}/relations": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaRelations",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns manga relations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/relation"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/people/{id}": {
"get": {
"tags": [
"people"
],
"operationId": "getPersonById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns pictures related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pictures variants"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/people/{id}/anime": {
"get": {
"tags": [
"people"
],
"operationId": "getPersonAnime",
"responses": {
"200": {
"description": "Returns person's anime staff positions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/person anime"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/people/{id}/voices": {
"get": {
"tags": [
"people"
],
"operationId": "getPersonVoices",
"responses": {
"200": {
"description": "Returns person's voice acting roles",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/person voice acting roles"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/people/{id}/manga": {
"get": {
"tags": [
"people"
],
"operationId": "getPersonManga",
"responses": {
"200": {
"description": "Returns person's published manga works",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/person manga"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/people/{id}/pictures": {
"get": {
"tags": [
"people"
],
"operationId": "getPersonPictures",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns a list of pictures of the person",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/person pictures"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/producers": {
"get": {
"tags": [
"producers"
],
"operationId": "getProducers",
"responses": {
"200": {
"description": "Returns producers collection",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/producers"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/random/anime": {
"get": {
"tags": [
"random"
],
"operationId": "getRandomAnime",
"responses": {
"200": {
"description": "Returns a random anime resource",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/anime"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/random/manga": {
"get": {
"tags": [
"random"
],
"operationId": "getRandomManga",
"responses": {
"200": {
"description": "Returns a random manga resource",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/manga"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/random/characters": {
"get": {
"tags": [
"random"
],
"operationId": "getRandomCharacters",
"responses": {
"200": {
"description": "Returns a random character resource",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/character"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/random/people": {
"get": {
"tags": [
"random"
],
"operationId": "getRandomPeople",
"responses": {
"200": {
"description": "Returns a random person resource",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/person"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/random/users": {
"get": {
"tags": [
"random"
],
"operationId": "getRandomUsers",
"responses": {
"200": {
"description": "Returns a random user profile resource",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/user profile"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/recommendations/anime": {
"get": {
"tags": [
"recommendations"
],
"operationId": "getRecentAnimeRecommendations",
"responses": {
"200": {
"description": "Returns recent anime recommendations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/recommendations"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/recommendations/manga": {
"get": {
"tags": [
"recommendations"
],
"operationId": "getRecentMangaRecommendations",
"responses": {
"200": {
"description": "Returns recent manga recommendations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/recommendations"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/reviews/anime": {
"get": {
"tags": [
"reviews"
],
"operationId": "getRecentAnimeReviews",
"responses": {
"200": {
"description": "Returns recent anime reviews",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"anime": {
"$ref": "#/components/schemas/anime meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/anime review"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/reviews/manga": {
"get": {
"tags": [
"reviews"
],
"operationId": "getRecentMangaReviews",
"responses": {
"200": {
"description": "Returns recent manga reviews",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"manga": {
"$ref": "#/components/schemas/manga meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/manga review"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/schedules": {
"get": {
"tags": [
"schedules"
],
"operationId": "getSchedules",
"parameters": [
{
"name": "topic",
"in": "path",
"description": "Filter by day",
"required": false,
"schema": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"unknown",
"other"
]
}
}
],
"responses": {
"200": {
"description": "Returns weekly schedule",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schedules"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeSearch",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/anime search query type"
}
},
{
"name": "score",
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "min_score",
"in": "query",
"description": "Set a minimum score for results.",
"schema": {
"type": "number"
}
},
{
"name": "max_score",
"in": "query",
"description": "Set a maximum score for results",
"schema": {
"type": "number"
}
},
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/anime search query status"
}
},
{
"name": "rating",
"in": "query",
"schema": {
"$ref": "#/components/schemas/anime search query rating"
}
},
{
"name": "sfw",
"in": "query",
"description": "Filter out Adult entries",
"schema": {
"type": "boolean"
}
},
{
"name": "genres",
"in": "query",
"description": "Filter by genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3",
"schema": {
"type": "string"
}
},
{
"name": "genres_exclude",
"in": "query",
"description": "Exclude genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3",
"schema": {
"type": "string"
}
},
{
"name": "order_by",
"in": "query",
"schema": {
"$ref": "#/components/schemas/anime search query orderby"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"$ref": "#/components/schemas/search query sort"
}
},
{
"name": "letter",
"in": "query",
"description": "Return entries starting with the given letter",
"schema": {
"type": "string"
}
},
{
"name": "producer",
"in": "query",
"description": "Filter by producer(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns search results for anime",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/manga": {
"get": {
"tags": [
"manga"
],
"operationId": "getMangaSearch",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/manga search query type"
}
},
{
"name": "score",
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "min_score",
"in": "query",
"description": "Set a minimum score for results.",
"schema": {
"type": "number"
}
},
{
"name": "max_score",
"in": "query",
"description": "Set a maximum score for results",
"schema": {
"type": "number"
}
},
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/manga search query status"
}
},
{
"name": "sfw",
"in": "query",
"description": "Filter out Adult entries",
"schema": {
"type": "boolean"
}
},
{
"name": "genres",
"in": "query",
"description": "Filter by genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3",
"schema": {
"type": "string"
}
},
{
"name": "genres_exclude",
"in": "query",
"description": "Exclude genre(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3",
"schema": {
"type": "string"
}
},
{
"name": "order_by",
"in": "query",
"schema": {
"$ref": "#/components/schemas/manga search query orderby"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"$ref": "#/components/schemas/search query sort"
}
},
{
"name": "letter",
"in": "query",
"description": "Return entries starting with the given letter",
"schema": {
"type": "string"
}
},
{
"name": "magazine",
"in": "query",
"description": "Filter by producer(s) IDs. Can pass multiple with a comma as a delimiter. e.g 1,2,3",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns search results for manga",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/people": {
"get": {
"tags": [
"people"
],
"operationId": "getPeopleSearch",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "order_by",
"in": "query",
"schema": {
"$ref": "#/components/schemas/people search query orderby"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"$ref": "#/components/schemas/search query sort"
}
},
{
"name": "letter",
"in": "query",
"description": "Return entries starting with the given letter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns search results for people",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/people search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/characters": {
"get": {
"tags": [
"characters"
],
"operationId": "getCharactersSearch",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "order_by",
"in": "query",
"schema": {
"$ref": "#/components/schemas/characters search query orderby"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"$ref": "#/components/schemas/search query sort"
}
},
{
"name": "letter",
"in": "query",
"description": "Return entries starting with the given letter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns search results for characters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/characters search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users": {
"get": {
"tags": [
"users"
],
"operationId": "getUsersSearch",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "gender",
"in": "query",
"schema": {
"$ref": "#/components/schemas/users search query gender"
}
},
{
"name": "location",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "maxAge",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "minAge",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns search results for users",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/users search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/userbyid": {
"get": {
"tags": [
"users"
],
"operationId": "getUserById",
"responses": {
"200": {
"description": "Returns username by ID search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user by id"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/clubs": {
"get": {
"tags": [
"clubs"
],
"operationId": "getClubsSearch",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/club search query type"
}
},
{
"name": "category",
"in": "query",
"schema": {
"$ref": "#/components/schemas/club search query category"
}
},
{
"name": "order_by",
"in": "query",
"schema": {
"$ref": "#/components/schemas/club search query orderby"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"$ref": "#/components/schemas/search query sort"
}
},
{
"name": "letter",
"in": "query",
"description": "Return entries starting with the given letter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns search results for clubs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clubs search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/seasons/{year}/{season}": {
"get": {
"tags": [
"seasons"
],
"operationId": "getSeason",
"responses": {
"200": {
"description": "Returns seasonal anime",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/seasons/now": {
"get": {
"tags": [
"seasons"
],
"operationId": "getSeasonNow",
"responses": {
"200": {
"description": "Returns current seasonal anime",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/seasons": {
"get": {
"tags": [
"seasons"
],
"operationId": "getSeasonsList",
"responses": {
"200": {
"description": "Returns available list of seasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/seasons"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/seasons/upcoming": {
"get": {
"tags": [
"seasons"
],
"operationId": "getSeasonUpcoming",
"responses": {
"200": {
"description": "Returns upcoming season's anime",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/top/anime": {
"get": {
"tags": [
"top"
],
"operationId": "getTopAnime",
"responses": {
"200": {
"description": "Returns top anime",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/top/manga": {
"get": {
"tags": [
"top"
],
"operationId": "getTopManga",
"responses": {
"200": {
"description": "Returns top manga",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/manga search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/top/people": {
"get": {
"tags": [
"top"
],
"operationId": "getTopPeople",
"responses": {
"200": {
"description": "Returns top people",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/people search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/top/characters": {
"get": {
"tags": [
"top"
],
"operationId": "getTopCharacters",
"responses": {
"200": {
"description": "Returns top characters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/characters search"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/top/reviews": {
"get": {
"tags": [
"top"
],
"operationId": "getTopReviews",
"responses": {
"200": {
"description": "Returns top reviews",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"anyOf": [
{
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"anime": {
"$ref": "#/components/schemas/anime meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/anime review"
}
]
},
{
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"manga": {
"$ref": "#/components/schemas/manga meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/manga review"
}
]
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}": {
"get": {
"tags": [
"users"
],
"operationId": "getUserProfile",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user profile",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user profile"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/statistics": {
"get": {
"tags": [
"users"
],
"operationId": "getUserStatistics",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user statistics",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user statistics"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/favorites": {
"get": {
"tags": [
"users"
],
"operationId": "getUserFavorites",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user favorites",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user favorites"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/userupdates": {
"get": {
"tags": [
"users"
],
"operationId": "getUserUpdates",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user updates",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user updates"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/about": {
"get": {
"tags": [
"users"
],
"operationId": "getUserAbout",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user about in raw HTML",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user about"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/history/{type}": {
"get": {
"tags": [
"users"
],
"operationId": "getUserHistory",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "path",
"required": false,
"schema": {
"type": "string",
"enum": [
"anime",
"manga"
]
}
}
],
"responses": {
"200": {
"description": "Returns user history (past 30 days)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user history"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/friends": {
"get": {
"tags": [
"users"
],
"operationId": "getUserFriends",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user friends",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user friends"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/animelist": {
"get": {
"tags": [
"users"
],
"description": "Anime lists will be discontinued from May 1st, 2022. <a href='https://docs.google.com/document/d/1-6H-agSnqa8Mfmw802UYfGQrceIEnAaEh4uCXAPiX5A'>Read more</a>",
"operationId": "getUserAnimelist",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user anime list",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
},
"deprecated": true
}
},
"/users/{username}/mangalist": {
"get": {
"tags": [
"users"
],
"description": "Manga lists will be discontinued from May 1st, 2022. <a href='https://docs.google.com/document/d/1-6H-agSnqa8Mfmw802UYfGQrceIEnAaEh4uCXAPiX5A'>Read more</a>",
"operationId": "getUserMangaList",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user manga list",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
},
"deprecated": true
}
},
"/users/{username}/reviews": {
"get": {
"tags": [
"users"
],
"operationId": "getUserReviews",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user reviews",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"anyOf": [
{
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"anime": {
"$ref": "#/components/schemas/anime meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/anime review"
}
]
},
{
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"manga": {
"$ref": "#/components/schemas/manga meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/manga review"
}
]
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/recommendations": {
"get": {
"tags": [
"users"
],
"operationId": "getUserRecommendations",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns Recent Anime Recommendations",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/recommendations"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/users/{username}/clubs": {
"get": {
"tags": [
"users"
],
"operationId": "getUserClubs",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns user clubs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user clubs"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/watch/episodes": {
"get": {
"tags": [
"watch"
],
"operationId": "getWatchRecentEpisodes",
"responses": {
"200": {
"description": "Returns Recently Added Episodes",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/watch episodes"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/watch/episodes/popular": {
"get": {
"tags": [
"watch"
],
"operationId": "getWatchPopularEpisodes",
"responses": {
"200": {
"description": "Returns Popular Episodes",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/watch episodes"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/watch/promos": {
"get": {
"tags": [
"watch"
],
"operationId": "getWatchRecentPromos",
"responses": {
"200": {
"description": "Returns Recently Added Promotional Videos",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/watch promos"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/watch/promos/popular": {
"get": {
"tags": [
"watch"
],
"operationId": "getWatchPopularPromos",
"responses": {
"200": {
"description": "Returns Popular Promotional Videos",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/watch promos"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
}
},
"components": {
"schemas": {
"anime episodes": {
"description": "Anime Episodes Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"title_japanese": {
"description": "Title Japanese",
"type": "string"
},
"title_romanji": {
"description": "title_romanji",
"type": "string"
},
"duration": {
"description": "Episode duration in seconds",
"type": "integer"
},
"aired": {
"description": "Aired Date ISO8601",
"type": "string"
},
"filler": {
"description": "Filler episode",
"type": "boolean"
},
"recap": {
"description": "Recap episode",
"type": "boolean"
},
"forum_url": {
"description": "Episode discussion forum URL",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"anime news": {
"description": "Anime News Resource",
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"$ref": "#/components/schemas/news"
}
]
},
"character pictures": {
"description": "Character Pictures",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"image_url": {
"description": "Default JPG Image Size URL",
"type": "string"
},
"large_image_url": {
"description": "Large JPG Image Size URL",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"club member": {
"description": "Club Member",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"username": {
"description": "MyAnimeList Username",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"image_url": {
"description": "MyAnimeList Image URL",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"manga news": {
"description": "Manga News Resource",
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"$ref": "#/components/schemas/news"
}
]
},
"manga pictures": {
"description": "Manga Pictures",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"image_url": {
"description": "Default JPG Image Size URL",
"type": "string"
},
"large_image_url": {
"description": "Large JPG Image Size URL",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"person pictures": {
"description": "Character Pictures",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"image_url": {
"description": "Default JPG Image Size URL",
"type": "string"
},
"large_image_url": {
"description": "Large JPG Image Size URL",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"random": {
"description": "Random Resources",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/anime"
},
{
"$ref": "#/components/schemas/manga"
},
{
"$ref": "#/components/schemas/character"
},
{
"$ref": "#/components/schemas/person"
}
]
}
}
},
"type": "object"
},
"schedules": {
"description": "Anime resources currently airing",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/anime"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"search query sort": {
"description": "Characters Search Query Sort",
"type": "string",
"enum": [
"desc",
"asc"
]
},
"users search": {
"description": "User Results",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"seasons": {
"description": "List of available seasons",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"year": {
"description": "Year",
"type": "integer"
},
"seasons": {
"description": "List of available seasons",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
}
},
"type": "object"
},
"reviews collection": {
"description": "Anime & Manga Reviews Resource",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/anime review"
},
{
"$ref": "#/components/schemas/manga review"
}
]
}
}
},
"type": "object"
},
"user friends": {
"description": "User Friends",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"properties": {
"last_online": {
"description": "Last Online Date ISO8601 format",
"type": "string"
},
"friends_since": {
"description": "Friends Since Date ISO8601 format",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"user clubs": {
"description": "User Clubs",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"name": {
"description": "Club Name",
"type": "string"
},
"url": {
"description": "Club URL",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"watch episodes": {
"description": "Watch Episodes",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"entry": {
"$ref": "#/components/schemas/anime meta"
},
"episodes": {
"description": "Recent Episodes (max 2 listed)",
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"title": {
"description": "Episode Title",
"type": "string"
},
"premium": {
"description": "For MyAnimeList Premium Users",
"type": "boolean"
}
},
"type": "object"
}
},
"region_locked": {
"description": "Region Locked Episode",
"type": "boolean"
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"watch promos": {
"description": "Watch Promos",
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"allOf": [
{
"properties": {
"title": {
"description": "Promo Title",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"entry": {
"$ref": "#/components/schemas/anime meta"
},
"trailer": {
"type": "array",
"items": {
"$ref": "#/components/schemas/trailer"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
]
}
]
},
"anime search query type": {
"description": "Available Anime types",
"type": "string",
"enum": [
"tv",
"movie",
"ova",
"special",
"ona",
"music"
]
},
"anime search query status": {
"description": "Available Anime statuses",
"type": "string",
"enum": [
"airing",
"complete",
"upcoming"
]
},
"anime search query rating": {
"description": "Available Anime audience ratings<br><br><b>Ratings</b><br><ul><li>G - All Ages</li><li>PG - Children</li><li>PG-13 - Teens 13 or older</li><li>R - 17+ (violence & profanity)</li><li>R+ - Mild Nudity</li><li>Rx - Hentai</li></ul>",
"type": "string",
"enum": [
"g",
"pg",
"pg13",
"r17",
"r",
"rx"
]
},
"anime search query orderby": {
"description": "Available Anime order_by properties",
"type": "string",
"enum": [
"mal_id",
"title",
"type",
"rating",
"start_date",
"end_date",
"episodes",
"score",
"scored_by",
"rank",
"popularity",
"members",
"favorites"
]
},
"characters search query orderby": {
"description": "Available Character order_by properties",
"type": "string",
"enum": [
"mal_id",
"name",
"favorites"
]
},
"club search query type": {
"description": "Club Search Query Type",
"type": "string",
"enum": [
"public",
"private",
"secret"
]
},
"club search query category": {
"description": "Club Search Query Category",
"type": "string",
"enum": [
"anime",
"manga",
"actors_and_artists",
"characters",
"cities_and_neighborhoods",
"companies",
"conventions",
"games",
"japan",
"music",
"other",
"schools"
]
},
"club search query orderby": {
"description": "Club Search Query OrderBy",
"type": "string",
"enum": [
"mal_id",
"title",
"members_count",
"pictures_count",
"created"
]
},
"magazines query orderby": {
"description": "Order by magazine data",
"type": "string",
"enum": [
"mal_id",
"name",
"count"
]
},
"manga search query type": {
"description": "Available Manga types",
"type": "string",
"enum": [
"manga",
"novel",
"lightnovel",
"oneshot",
"doujin",
"manhwa",
"manhua"
]
},
"manga search query status": {
"description": "Available Manga statuses",
"type": "string",
"enum": [
"publishing",
"complete",
"hiatus",
"discontinued",
"upcoming"
]
},
"manga search query orderby": {
"description": "Available Manga order_by properties",
"type": "string",
"enum": [
"mal_id",
"title",
"start_date",
"end_date",
"chapters",
"volumes",
"score",
"scored_by",
"rank",
"popularity",
"members",
"favorites"
]
},
"people search query orderby": {
"description": "Available People order_by properties",
"type": "string",
"enum": [
"mal_id",
"name",
"birthday",
"favorites"
]
},
"producers query orderby": {
"description": "Order by producers data",
"type": "string",
"enum": [
"mal_id",
"name",
"count"
]
},
"users search query gender": {
"description": "Users Search Query Gender",
"type": "string",
"enum": [
"any",
"male",
"female",
"nonbinary"
]
},
"anime characters": {
"description": "Anime Characters Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"character": {
"description": "Character details",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/character images"
},
"name": {
"description": "Character Name",
"type": "string"
}
},
"type": "object"
},
"role": {
"description": "Character's Role",
"type": "string"
},
"voice_actors": {
"type": "array",
"items": {
"properties": {
"person": {
"properties": {
"mal_id": {
"type": "integer"
},
"url": {
"type": "string"
},
"images": {
"$ref": "#/components/schemas/people images"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"language": {
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
},
"anime search": {
"description": "Anime Collection Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/anime"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"anime episode": {
"description": "Anime Episode Resource",
"properties": {
"data": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"title_japanese": {
"description": "Title Japanese",
"type": "string"
},
"title_romanji": {
"description": "title_romanji",
"type": "string"
},
"duration": {
"description": "Episode duration in seconds",
"type": "integer"
},
"aired": {
"description": "Aired Date ISO8601",
"type": "string"
},
"filler": {
"description": "Filler episode",
"type": "boolean"
},
"recap": {
"description": "Recap episode",
"type": "boolean"
},
"synopsis": {
"description": "Episode Synopsis",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"anime relations": {
"description": "Anime Relations",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"relation": {
"description": "Relation type",
"type": "string"
},
"entry": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
}
},
"type": "object"
}
}
},
"type": "object"
},
"anime": {
"description": "Anime Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/anime images"
},
"trailer": {
"$ref": "#/components/schemas/trailer base"
},
"title": {
"description": "Title",
"type": "string"
},
"title_english": {
"description": "English Title",
"type": "string"
},
"title_japanese": {
"description": "Japanese Title",
"type": "string"
},
"title_synonyms": {
"description": "Other Titles",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Anime Type",
"type": "string",
"enum": [
"TV",
"OVA",
"Movie",
"Special",
"ONA",
"Music"
]
},
"source": {
"description": "Original Material/Source adapted from",
"type": "string"
},
"episodes": {
"description": "Episode count",
"type": "integer"
},
"status": {
"description": "Airing status",
"type": "string",
"enum": [
"Finished Airing",
"Currently Airing",
"Not yet aired"
]
},
"airing": {
"description": "Airing boolean",
"type": "boolean"
},
"aired": {
"$ref": "#/components/schemas/daterange"
},
"duration": {
"description": "Parsed raw duration",
"type": "string"
},
"rating": {
"description": "Anime audience rating",
"type": "string",
"enum": [
"G - All Ages",
"PG - Children",
"PG-13 - Teens 13 or older",
"R - 17+ (violence & profanity)",
"R+ - Mild Nudity",
"Rx - Hentai"
]
},
"score": {
"description": "Score",
"type": "number",
"format": "float"
},
"scored_by": {
"description": "Number of users",
"type": "integer"
},
"rank": {
"description": "Ranking",
"type": "integer"
},
"popularity": {
"description": "Popularity",
"type": "integer"
},
"members": {
"description": "Number of users who have added this entry to their list",
"type": "integer"
},
"favorites": {
"description": "Number of users who have favorited this entry",
"type": "integer"
},
"synopsis": {
"description": "Synopsis",
"type": "string"
},
"background": {
"description": "Background",
"type": "string"
},
"season": {
"description": "Season",
"type": "string",
"enum": [
"Summer",
"Winter",
"Spring",
"Fall"
]
},
"year": {
"description": "Year",
"type": "integer"
},
"broadcast": {
"$ref": "#/components/schemas/broadcast"
},
"producers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"licensors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"studios": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"genres": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"explicit_genres": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"themes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"demographics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
}
},
"type": "object"
},
"anime staff": {
"description": "Anime Staff Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"person": {
"description": "Person details",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/people images"
},
"name": {
"description": "Name",
"type": "string"
}
},
"type": "object"
},
"positions": {
"description": "Staff Positions",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
}
},
"type": "object"
},
"anime statistics": {
"description": "Anime Statistics Resource",
"properties": {
"data": {
"properties": {
"watching": {
"description": "Number of users watching the resource",
"type": "integer"
},
"completed": {
"description": "Number of users who have completed the resource",
"type": "integer"
},
"on_hold": {
"description": "Number of users who have put the resource on hold",
"type": "integer"
},
"dropped": {
"description": "Number of users who have dropped the resource",
"type": "integer"
},
"plan_to_watch": {
"description": "Number of users who have planned to watch the resource",
"type": "integer"
},
"total": {
"description": "Total number of users who have the resource added to their lists",
"type": "integer"
},
"scores": {
"type": "array",
"items": {
"properties": {
"score": {
"description": "Scoring value",
"type": "integer"
},
"votes": {
"description": "Number of votes for this score",
"type": "integer"
},
"percentage": {
"description": "Percentage of votes for this score",
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
},
"anime themes": {
"description": "Anime Opening and Ending Themes",
"properties": {
"data": {
"properties": {
"openings": {
"type": "array",
"items": {
"type": "string"
}
},
"endings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
},
"type": "object"
},
"anime videos": {
"description": "Anime Videos Resource",
"properties": {
"data": {
"properties": {
"promos": {
"type": "array",
"items": {
"properties": {
"title": {
"description": "Title",
"type": "string"
},
"trailer": {
"$ref": "#/components/schemas/trailer"
}
},
"type": "object"
}
},
"episodes": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"episode": {
"description": "Episode",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/common images"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
},
"character anime": {
"description": "Character casted in anime",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"role": {
"description": "Character's Role",
"type": "string"
},
"anime": {
"$ref": "#/components/schemas/anime meta"
}
},
"type": "object"
}
}
},
"type": "object"
},
"characters search": {
"description": "Characters Search Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/character"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"character manga": {
"description": "Character casted in manga",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"role": {
"description": "Character's Role",
"type": "string"
},
"manga": {
"$ref": "#/components/schemas/manga meta"
}
},
"type": "object"
}
}
},
"type": "object"
},
"character": {
"description": "Character Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/character images"
},
"name": {
"description": "Name",
"type": "string"
},
"nicknames": {
"description": "Other Names",
"type": "array",
"items": {
"type": "string"
}
},
"favorites": {
"description": "Number of users who have favorited this entry",
"type": "integer"
},
"about": {
"description": "Synopsis",
"type": "string"
},
"animeography": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"image_url": {
"type": "string"
},
"role": {
"type": "string"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/mal_url"
}
]
}
},
"mangaography": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"image_url": {
"type": "string"
},
"role": {
"type": "string"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/mal_url"
}
]
}
},
"voice_actors": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"image_url": {
"type": "string"
},
"language": {
"type": "string"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/mal_url"
}
]
}
}
},
"type": "object"
},
"character voice actors": {
"description": "Character voice actors",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"language": {
"description": "Character's Role",
"type": "string"
},
"person": {
"$ref": "#/components/schemas/person meta"
}
},
"type": "object"
}
}
},
"type": "object"
},
"clubs search": {
"description": "Clubs Search Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/club"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"club relations": {
"description": "Club Relations",
"properties": {
"data": {
"properties": {
"anime": {
"type": "array",
"items": {
"properties": {
"": {
"$ref": "#/components/schemas/mal_url"
}
},
"type": "object"
}
},
"manga": {
"type": "array",
"items": {
"properties": {
"": {
"$ref": "#/components/schemas/mal_url"
}
},
"type": "object"
}
},
"characters": {
"type": "array",
"items": {
"properties": {
"": {
"$ref": "#/components/schemas/mal_url"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
},
"club": {
"description": "Club Resource",
"properties": {
"data": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"name": {
"description": "Club name",
"type": "string"
},
"url": {
"description": "Club URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/common images"
},
"members": {
"description": "Number of club members",
"type": "integer"
},
"category": {
"description": "Club Category",
"type": "string",
"enum": [
"actors & artists",
"anime",
"characters",
"cities & neighborhoods",
"companies",
"conventions",
"games",
"japan",
"manga",
"music",
"others",
"schools"
]
},
"created": {
"description": "Date Created ISO8601",
"type": "string"
},
"access": {
"description": "Club access",
"type": "string",
"enum": [
"public",
"private",
"secret"
]
}
},
"type": "object"
}
},
"type": "object"
},
"club staff": {
"description": "Club Staff Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"url": {
"description": "User URL",
"type": "string"
},
"username": {
"description": "User's username",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"trailer": {
"description": "Youtube Details",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/trailer base"
},
{
"$ref": "#/components/schemas/trailer images"
}
]
},
"trailer base": {
"description": "Youtube Details",
"properties": {
"youtube_id": {
"description": "YouTube ID",
"type": "string"
},
"url": {
"description": "YouTube URL",
"type": "string"
},
"embed_url": {
"description": "Parsed Embed URL",
"type": "string"
}
},
"type": "object"
},
"trailer images": {
"description": "Youtube Images",
"properties": {
"images": {
"properties": {
"default_image_url": {
"description": "Default Image Size URL (120x90)",
"type": "string"
},
"small_image_url": {
"description": "Small Image Size URL (640x480)",
"type": "string"
},
"medium_image_url": {
"description": "Medium Image Size URL (320x180)",
"type": "string"
},
"large_image_url": {
"description": "Large Image Size URL (480x360)",
"type": "string"
},
"maximum_image_url": {
"description": "Maximum Image Size URL (1280x720)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"daterange": {
"description": "Date range",
"properties": {
"from": {
"description": "Date ISO8601",
"type": "string"
},
"to": {
"description": "Date ISO8601",
"type": "string"
},
"prop": {
"description": "Date Prop",
"properties": {
"from": {
"description": "Date Prop From",
"properties": {
"day": {
"description": "Day",
"type": "integer"
},
"month": {
"description": "Month",
"type": "integer"
},
"year": {
"description": "year",
"type": "integer"
}
},
"type": "object"
},
"to": {
"description": "Date Prop To",
"properties": {
"day": {
"description": "Day",
"type": "integer"
},
"month": {
"description": "Month",
"type": "integer"
},
"year": {
"description": "year",
"type": "integer"
}
},
"type": "object"
},
"string": {
"description": "Raw parsed string",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"broadcast": {
"description": "Broadcast Details",
"properties": {
"day": {
"description": "Day of the week",
"type": "string"
},
"time": {
"description": "Time in 24 hour format",
"type": "string"
},
"timezone": {
"description": "Timezone (Tz Database format https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)",
"type": "string"
},
"string": {
"description": "Raw parsed broadcast string",
"type": "string"
}
},
"type": "object"
},
"mal_url": {
"description": "Parsed URL Data",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"type": {
"description": "Type of resource",
"type": "string"
},
"name": {
"description": "Resource Name/Title",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
}
},
"type": "object"
},
"mal_url_2": {
"description": "Parsed URL Data",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"type": {
"description": "Type of resource",
"type": "string"
},
"title": {
"description": "Resource Name/Title",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
}
},
"type": "object"
},
"entry_meta": {
"description": "Entry Meta data",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"image_url": {
"description": "Image URL",
"type": "string"
},
"name": {
"description": "Entry Name/Title",
"type": "string"
}
},
"type": "object"
},
"relation": {
"description": "Related resources",
"type": "array",
"items": {
"properties": {
"relation": {
"description": "Relation type",
"type": "string"
},
"items": {
"description": "Related items",
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
}
},
"type": "object"
}
},
"pagination": {
"properties": {
"pagination": {
"properties": {
"last_visible_page": {
"type": "integer"
},
"has_next_page": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"user meta": {
"properties": {
"username": {
"description": "MyAnimeList Username",
"type": "string"
},
"url": {
"description": "MyAnimeList Profile URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/user images"
}
},
"type": "object"
},
"user by id": {
"description": "User Meta By ID",
"properties": {
"data": {
"properties": {
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"username": {
"description": "MyAnimeList Username",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"user images": {
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
}
},
"type": "object"
},
"webp": {
"description": "Available images in WEBP",
"properties": {
"image_url": {
"description": "Image URL WEBP (225x335)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"anime meta": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/anime images"
},
"title": {
"description": "Entry title",
"type": "string"
}
},
"type": "object"
},
"manga meta": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/manga images"
},
"title": {
"description": "Entry title",
"type": "string"
}
},
"type": "object"
},
"character meta": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/character images"
},
"name": {
"description": "Entry name",
"type": "string"
}
},
"type": "object"
},
"person meta": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/people images"
},
"name": {
"description": "Entry name",
"type": "string"
}
},
"type": "object"
},
"anime images": {
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
},
"small_image_url": {
"description": "Small Image URL JPG (50x74)",
"type": "string"
},
"large_image_url": {
"description": "Image URL JPG (300x446)",
"type": "string"
}
},
"type": "object"
},
"webp": {
"description": "Available images in WEBP",
"properties": {
"image_url": {
"description": "Image URL WEBP (225x335)",
"type": "string"
},
"small_image_url": {
"description": "Small Image URL WEBP (50x74)",
"type": "string"
},
"large_image_url": {
"description": "Image URL WEBP (300x446)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"manga images": {
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
},
"small_image_url": {
"description": "Small Image URL JPG (50x74)",
"type": "string"
},
"large_image_url": {
"description": "Image URL JPG (300x446)",
"type": "string"
}
},
"type": "object"
},
"webp": {
"description": "Available images in WEBP",
"properties": {
"image_url": {
"description": "Image URL WEBP (225x335)",
"type": "string"
},
"small_image_url": {
"description": "Small Image URL WEBP (50x74)",
"type": "string"
},
"large_image_url": {
"description": "Image URL WEBP (300x446)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"character images": {
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
},
"small_image_url": {
"description": "Small Image URL JPG (50x74)",
"type": "string"
}
},
"type": "object"
},
"webp": {
"description": "Available images in WEBP",
"properties": {
"image_url": {
"description": "Image URL WEBP (225x335)",
"type": "string"
},
"small_image_url": {
"description": "Small Image URL WEBP (50x74)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"people images": {
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"common images": {
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"forum": {
"description": "Forum Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"date": {
"description": "Post Date ISO8601",
"type": "string"
},
"author_username": {
"description": "Author MyAnimeList Username",
"type": "string"
},
"author_url": {
"description": "Author Profile URL",
"type": "string"
},
"comments": {
"description": "Comment count",
"type": "integer"
},
"last_comment": {
"description": "Last comment details",
"properties": {
"url": {
"description": "Last comment URL",
"type": "string"
},
"author_username": {
"description": "Author MyAnimeList Username",
"type": "string"
},
"author_url": {
"description": "Author Profile URL",
"type": "string"
},
"date": {
"description": "Last comment date posted ISO8601",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"type": "object"
},
"genres": {
"description": "Genres Collection Resource",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/genre"
}
}
},
"type": "object"
},
"genre query filter": {
"description": "Filter genres by type",
"type": "string",
"enum": [
"genres",
"explicit_genres",
"themes",
"demographics"
]
},
"genre": {
"description": "Genre Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"name": {
"description": "Genre Name",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"count": {
"description": "Genre's entry count",
"type": "integer"
}
},
"type": "object"
},
"magazines": {
"description": "Magazine Collection Resource",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"$ref": "#/components/schemas/magazine"
}
]
}
},
"type": "object"
},
"magazine": {
"description": "Magazine Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"name": {
"description": "Magazine Name",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"count": {
"description": "Magazine's manga count",
"type": "integer"
}
},
"type": "object"
},
"manga characters": {
"description": "Manga Characters Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"character": {
"$ref": "#/components/schemas/character meta"
},
"role": {
"description": "Character's Role",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"manga search": {
"description": "Manga Search Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/manga"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"manga": {
"description": "Manga Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/manga images"
},
"title": {
"description": "Title",
"type": "string"
},
"title_english": {
"description": "English Title",
"type": "string"
},
"title_japanese": {
"description": "Japanese Title",
"type": "string"
},
"title_synonyms": {
"description": "Other Titles",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Manga Type",
"type": "string",
"enum": [
"Manga",
"Novel",
"One-shot",
"Doujinshi",
"Manhua",
"Manhwa",
"OEL"
]
},
"chapters": {
"description": "Chapter count",
"type": "integer"
},
"volumnes": {
"description": "Volume count",
"type": "integer"
},
"status": {
"description": "Publishing status",
"type": "string",
"enum": [
"Finished",
"Publishing",
"On Hiatus",
"Discontinued",
"Not yet published"
]
},
"publishing": {
"description": "Publishing boolean",
"type": "boolean"
},
"published": {
"$ref": "#/components/schemas/daterange"
},
"score": {
"description": "Score",
"type": "number",
"format": "float"
},
"scored_by": {
"description": "Number of users",
"type": "integer"
},
"rank": {
"description": "Ranking",
"type": "integer"
},
"popularity": {
"description": "Popularity",
"type": "integer"
},
"members": {
"description": "Number of users who have added this entry to their list",
"type": "integer"
},
"favorites": {
"description": "Number of users who have favorited this entry",
"type": "integer"
},
"synopsis": {
"description": "Synopsis",
"type": "string"
},
"background": {
"description": "Background",
"type": "string"
},
"authors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"serializations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"genres": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"explicit_genres": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"themes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
},
"demographics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/mal_url"
}
}
},
"type": "object"
},
"manga statistics": {
"description": "Manga Statistics Resource",
"properties": {
"data": {
"properties": {
"reading": {
"description": "Number of users reading the resource",
"type": "integer"
},
"completed": {
"description": "Number of users who have completed the resource",
"type": "integer"
},
"on_hold": {
"description": "Number of users who have put the resource on hold",
"type": "integer"
},
"dropped": {
"description": "Number of users who have dropped the resource",
"type": "integer"
},
"plan_to_read": {
"description": "Number of users who have planned to read the resource",
"type": "integer"
},
"total": {
"description": "Total number of users who have the resource added to their lists",
"type": "integer"
},
"scores": {
"type": "array",
"items": {
"properties": {
"score": {
"description": "Scoring value",
"type": "integer"
},
"votes": {
"description": "Number of votes for this score",
"type": "integer"
},
"percentage": {
"description": "Percentage of votes for this score",
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
},
"moreinfo": {
"description": "More Info Resource",
"properties": {
"data": {
"properties": {
"moreinfo": {
"description": "Additional information on the entry",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"news": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"title": {
"description": "Title",
"type": "string"
},
"date": {
"description": "Post Date ISO8601",
"type": "string"
},
"author_username": {
"description": "Author MyAnimeList Username",
"type": "string"
},
"author_url": {
"description": "Author Profile URL",
"type": "string"
},
"forum_url": {
"description": "Forum topic URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/common images"
},
"comments": {
"description": "Comment count",
"type": "integer"
},
"excerpt": {
"description": "Excerpt",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"person anime": {
"description": "Person anime staff positions",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"position": {
"description": "Person's position",
"type": "string"
},
"anime": {
"$ref": "#/components/schemas/anime meta"
}
},
"type": "object"
}
}
},
"type": "object"
},
"people search": {
"description": "People Search",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/person"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"person manga": {
"description": "Person's mangaography",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"position": {
"description": "Person's position",
"type": "string"
},
"manga": {
"$ref": "#/components/schemas/manga meta"
}
},
"type": "object"
}
}
},
"type": "object"
},
"person": {
"description": "Person Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"website_url": {
"description": "Person's website URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/people images"
},
"name": {
"description": "Name",
"type": "string"
},
"given_name": {
"description": "Given Name",
"type": "string"
},
"family_name": {
"description": "Family Name",
"type": "string"
},
"alternate_names": {
"description": "Other Names",
"type": "array",
"items": {
"type": "string"
}
},
"birthday": {
"description": "Birthday Date ISO8601",
"type": "string"
},
"favorites": {
"description": "Number of users who have favorited this entry",
"type": "integer"
},
"about": {
"description": "Biography",
"type": "string"
}
},
"type": "object"
},
"person voice acting roles": {
"description": "Person's voice acting roles",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"role": {
"description": "Person's Character's role in the anime",
"type": "string"
},
"anime": {
"$ref": "#/components/schemas/anime meta"
},
"character": {
"$ref": "#/components/schemas/character meta"
}
},
"type": "object"
}
}
},
"type": "object"
},
"pictures": {
"description": "Pictures Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"images": {
"$ref": "#/components/schemas/anime images"
}
},
"type": "object"
}
}
},
"type": "object"
},
"pictures variants": {
"description": "Pictures Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"images": {
"$ref": "#/components/schemas/common images"
}
},
"type": "object"
}
}
},
"type": "object"
},
"producers": {
"description": "Producer Collection Resource",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"$ref": "#/components/schemas/producer"
}
]
}
},
"type": "object"
},
"producer": {
"description": "Producer Resource",
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"name": {
"description": "Producer Name",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"count": {
"description": "Producer's anime count",
"type": "integer"
}
},
"type": "object"
},
"user about": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"about": {
"description": "User About. NOTE: About information is customizable by users through BBCode on MyAnimeList. This means users can add multimedia content, different text sizes, etc. Due to this freeform, Jikan returns parsed HTML. Validate on your end!",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"user favorites": {
"properties": {
"data": {
"description": "Favorite entries",
"properties": {
"anime": {
"description": "Favorite Anime",
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"type": {
"type": "string"
},
"start_year": {
"type": "integer"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/anime meta"
}
]
}
},
"manga": {
"description": "Favorite Manga",
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"type": {
"type": "string"
},
"start_year": {
"type": "integer"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/manga meta"
}
]
}
},
"characters": {
"description": "Favorite Characters",
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"": {
"$ref": "#/components/schemas/mal_url_2"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/character meta"
}
]
}
},
"people": {
"description": "Favorite People",
"type": "array",
"items": {
"properties": {
"": {
"$ref": "#/components/schemas/character meta"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
},
"user history": {
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
},
"history": {
"description": "Transform the resource into an array.",
"properties": {
"entry": {
"$ref": "#/components/schemas/mal_url"
},
"increment": {
"description": "Number of episodes/chapters watched/read",
"type": "integer"
},
"date": {
"description": "Date ISO8601",
"type": "string"
}
},
"type": "object"
},
"user updates": {
"properties": {
"data": {
"properties": {
"anime": {
"description": "Last updated Anime",
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"entry": {
"$ref": "#/components/schemas/anime meta"
}
},
"type": "object"
},
{
"properties": {
"score": {
"type": "integer"
},
"status": {
"type": "string"
},
"episodes_seen": {
"type": "integer"
},
"episodes_total": {
"type": "integer"
},
"date": {
"description": "ISO8601 format",
"type": "string"
}
},
"type": "object"
}
]
}
},
"manga": {
"description": "Last updated Manga",
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"entry": {
"$ref": "#/components/schemas/manga meta"
}
},
"type": "object"
},
{
"properties": {
"score": {
"type": "integer"
},
"status": {
"type": "string"
},
"chapters_read": {
"type": "integer"
},
"chapters_total": {
"type": "integer"
},
"volumes_read": {
"type": "integer"
},
"volumes_total": {
"type": "integer"
},
"date": {
"description": "ISO8601 format",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"type": "object"
}
},
"type": "object"
},
"user profile": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"username": {
"description": "MyAnimeList Username",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/user images"
},
"last_online": {
"description": "Last Online Date ISO8601",
"type": "string"
},
"gender": {
"description": "User Gender",
"type": "string"
},
"birthday": {
"description": "Birthday Date ISO8601",
"type": "string"
},
"location": {
"description": "Location",
"type": "string"
},
"joined": {
"description": "Joined Date ISO8601",
"type": "string"
}
},
"type": "object"
},
"users temp": {
"description": "Transform the resource into an array.",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"username": {
"description": "MyAnimeList Username",
"type": "string"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"images": {
"description": "Images",
"properties": {
"jpg": {
"description": "Available images in JPG",
"properties": {
"image_url": {
"description": "Image URL JPG (225x335)",
"type": "string"
}
},
"type": "object"
},
"webp": {
"description": "Available images in WEBP",
"properties": {
"image_url": {
"description": "Image URL WEBP (225x335)",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"last_online": {
"description": "Last Online Date ISO8601",
"type": "string"
},
"gender": {
"description": "User Gender",
"type": "string"
},
"birthday": {
"description": "Birthday Date ISO8601",
"type": "string"
},
"location": {
"description": "Location",
"type": "string"
},
"joined": {
"description": "Joined Date ISO8601",
"type": "string"
},
"anime_stats": {
"description": "Anime Stats",
"properties": {
"days_watched": {
"description": "Number of days spent watching Anime",
"type": "number",
"format": "float"
},
"mean_score": {
"description": "Mean Score",
"type": "number",
"format": "float"
},
"watching": {
"description": "Anime Watching",
"type": "integer"
},
"completed": {
"description": "Anime Completed",
"type": "integer"
},
"on_hold": {
"description": "Anime On-Hold",
"type": "integer"
},
"dropped": {
"description": "Anime Dropped",
"type": "integer"
},
"plan_to_watch": {
"description": "Anime Planned to Watch",
"type": "integer"
},
"total_entries": {
"description": "Total Anime entries on User list",
"type": "integer"
},
"rewatched": {
"description": "Anime re-watched",
"type": "integer"
},
"episodes_watched": {
"description": "Number of Anime Episodes Watched",
"type": "integer"
}
},
"type": "object"
},
"manga_stats": {
"description": "Manga Stats",
"properties": {
"days_read": {
"description": "Number of days spent reading Manga",
"type": "number",
"format": "float"
},
"mean_score": {
"description": "Mean Score",
"type": "number",
"format": "float"
},
"reading": {
"description": "Manga Reading",
"type": "integer"
},
"completed": {
"description": "Manga Completed",
"type": "integer"
},
"on_hold": {
"description": "Manga On-Hold",
"type": "integer"
},
"dropped": {
"description": "Manga Dropped",
"type": "integer"
},
"plan_to_read": {
"description": "Manga Planned to Read",
"type": "integer"
},
"total_entries": {
"description": "Total Manga entries on User list",
"type": "integer"
},
"reread": {
"description": "Manga re-read",
"type": "integer"
},
"chapters_read": {
"description": "Number of Manga Chapters Read",
"type": "integer"
},
"volumes_read": {
"description": "Number of Manga Volumes Read",
"type": "integer"
}
},
"type": "object"
},
"favorites": {
"description": "Favorite entries",
"properties": {
"anime": {
"description": "Favorite Anime",
"type": "array",
"items": {
"$ref": "#/components/schemas/entry_meta"
}
},
"manga": {
"description": "Favorite Manga",
"type": "array",
"items": {
"$ref": "#/components/schemas/entry_meta"
}
},
"characters": {
"description": "Favorite Characters",
"type": "array",
"items": {
"$ref": "#/components/schemas/entry_meta"
}
},
"people": {
"description": "Favorite People",
"type": "array",
"items": {
"$ref": "#/components/schemas/entry_meta"
}
}
},
"type": "object"
},
"about": {
"description": "User About. NOTE: About information is customizable by users through BBCode on MyAnimeList. This means users can add multimedia content, different text sizes, etc. Due to this freeform, Jikan returns parsed HTML. Validate on your end!",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"user statistics": {
"properties": {
"data": {
"properties": {
"anime": {
"description": "Anime Statistics",
"properties": {
"days_watched": {
"description": "Number of days spent watching Anime",
"type": "number",
"format": "float"
},
"mean_score": {
"description": "Mean Score",
"type": "number",
"format": "float"
},
"watching": {
"description": "Anime Watching",
"type": "integer"
},
"completed": {
"description": "Anime Completed",
"type": "integer"
},
"on_hold": {
"description": "Anime On-Hold",
"type": "integer"
},
"dropped": {
"description": "Anime Dropped",
"type": "integer"
},
"plan_to_watch": {
"description": "Anime Planned to Watch",
"type": "integer"
},
"total_entries": {
"description": "Total Anime entries on User list",
"type": "integer"
},
"rewatched": {
"description": "Anime re-watched",
"type": "integer"
},
"episodes_watched": {
"description": "Number of Anime Episodes Watched",
"type": "integer"
}
},
"type": "object"
},
"manga": {
"description": "Manga Statistics",
"properties": {
"days_read": {
"description": "Number of days spent reading Manga",
"type": "number",
"format": "float"
},
"mean_score": {
"description": "Mean Score",
"type": "number",
"format": "float"
},
"reading": {
"description": "Manga Reading",
"type": "integer"
},
"completed": {
"description": "Manga Completed",
"type": "integer"
},
"on_hold": {
"description": "Manga On-Hold",
"type": "integer"
},
"dropped": {
"description": "Manga Dropped",
"type": "integer"
},
"plan_to_read": {
"description": "Manga Planned to Read",
"type": "integer"
},
"total_entries": {
"description": "Total Manga entries on User list",
"type": "integer"
},
"reread": {
"description": "Manga re-read",
"type": "integer"
},
"chapters_read": {
"description": "Number of Manga Chapters Read",
"type": "integer"
},
"volumes_read": {
"description": "Number of Manga Volumes Read",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"recommendations": {
"description": "Recommendations",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MAL IDs of recommendations is both of the MAL ID's with a `-` delimiter",
"type": "String"
},
"entry": {
"description": "Array of 2 entries that are being recommended to each other",
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/anime meta"
},
{
"$ref": "#/components/schemas/manga meta"
}
]
}
},
"content": {
"description": "Recommendation context provided by the user",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/user by id"
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"entry recommendations": {
"description": "Entry Recommendations Resource",
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"entry": {
"description": "Array of 2 entries that are being recommended to each other",
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/anime meta"
},
{
"$ref": "#/components/schemas/manga meta"
}
]
}
},
"url": {
"description": "Recommendation MyAnimeList URL",
"type": "string"
},
"votes": {
"description": "Number of users who have recommended this entry",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"manga review": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"type": {
"description": "Entry Type",
"type": "string"
},
"votes": {
"description": "Number of user votes on the Review",
"type": "integer"
},
"date": {
"description": "Review created date ISO8601",
"type": "string"
},
"chapters_read": {
"description": "Number of chapters read by the reviewer",
"type": "integer"
},
"review": {
"description": "Review content",
"type": "string"
},
"scores": {
"description": "Review Scores breakdown",
"properties": {
"overall": {
"description": "Overall Score",
"type": "integer"
},
"story": {
"description": "Story Score",
"type": "integer"
},
"art": {
"description": "Art Score",
"type": "integer"
},
"character": {
"description": "Character Score",
"type": "integer"
},
"enjoyment": {
"description": "Enjoyment Score",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"anime review": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID",
"type": "integer"
},
"url": {
"description": "MyAnimeList URL",
"type": "string"
},
"type": {
"description": "Entry Type",
"type": "string"
},
"votes": {
"description": "Number of user votes on the Review",
"type": "integer"
},
"date": {
"description": "Review created date ISO8601",
"type": "string"
},
"review": {
"description": "Review content",
"type": "string"
},
"episodes_watched": {
"description": "Number of episodes watched",
"type": "integer"
},
"scores": {
"description": "Review Scores breakdown",
"properties": {
"overall": {
"description": "Overall Score",
"type": "integer"
},
"story": {
"description": "Story Score",
"type": "integer"
},
"animation": {
"description": "Animation Score",
"type": "integer"
},
"sound": {
"description": "Sound Score",
"type": "integer"
},
"character": {
"description": "Character Score",
"type": "integer"
},
"enjoyment": {
"description": "Enjoyment Score",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"anime reviews": {
"description": "Anime Reviews Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/anime review"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"manga reviews": {
"description": "Manga Reviews Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/manga review"
}
]
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"anime userupdates": {
"description": "Anime User Updates Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
},
"score": {
"description": "User Score",
"type": "integer"
},
"status": {
"description": "User list status",
"type": "string"
},
"episodes_seen": {
"description": "Number of episodes seen",
"type": "integer"
},
"episodes_total": {
"description": "Total number of episodes",
"type": "integer"
},
"date": {
"description": "Last updated date ISO8601",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"manga userupdates": {
"description": "Manga User Updates Resource",
"allOf": [
{
"$ref": "#/components/schemas/pagination"
},
{
"property": "data",
"type": "array",
"items": {
"properties": {
"user": {
"$ref": "#/components/schemas/user meta"
},
"score": {
"description": "User Score",
"type": "integer"
},
"status": {
"description": "User list status",
"type": "string"
},
"volumes_read": {
"description": "Number of volumes read",
"type": "integer"
},
"volumes_total": {
"description": "Total number of volumes",
"type": "integer"
},
"chapters_read": {
"description": "Number of chapters read",
"type": "integer"
},
"chapters_total": {
"description": "Total number of chapters",
"type": "integer"
},
"date": {
"description": "Last updated date ISO8601",
"type": "string"
}
},
"type": "object"
}
}
]
}
},
"parameters": {
"page": {
"name": "page",
"in": "query",
"schema": {
"type": "integer"
}
},
"limit": {
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
}
},
"externalDocs": {
"description": "About",
"url": "https://jikan.moe"
}
}
Reference in New Issue View Git Blame Copy Permalink