{"docs":{"name":"Shikimori API","info":"\n\u003ch2 id=\"welcome_to_shikimori_api_v2\"\u003eWelcome to Shikimori API v2\u003c/h2\u003e\n\n\u003cp\u003eThe API has three versions: \u003ca href=\"/api/doc/graphql\"\u003e\u003cstrong\u003egraphql\u003c/strong\u003e\u003c/a\u003e, outdated \u003ca href=\"/api/doc/2.0.html\"\u003e\u003cstrong\u003ev2\u003c/strong\u003e\u003c/a\u003e and outdated \u003ca href=\"/api/doc/1.0.html\"\u003e\u003cstrong\u003ev1\u003c/strong\u003e\u003c/a\u003e. Prefer using \u003ccode\u003egraphql\u003c/code\u003e over \u003ccode\u003ev2\u003c/code\u003e/\u003ccode\u003ev1\u003c/code\u003e when it is possible.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003ePlease do not parse the main site\u003c/strong\u003e. Fetch all necessary data via API.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eNOTE:\u003c/strong\u003e New anime/manga/character/person posters available only in \u003ccode\u003egraphql\u003c/code\u003e API.\u003c/p\u003e\n\n\u003cp\u003eAPI works with \u003ccode\u003eHTTPS\u003c/code\u003e protocol only. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"documentation_for_graphql\"\u003eDocumentation for GraphQL\u003c/h3\u003e\n\n\u003cp\u003e\u003ca href=\"/api/doc/graphql\"\u003eClick here\u003c/a\u003e. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"documentation_for_v1\"\u003eDocumentation for V1\u003c/h3\u003e\n\n\u003cp\u003e\u003ca href=\"/api/doc/1.0.html\"\u003eClick here\u003c/a\u003e. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"documentation_for_v2\"\u003eDocumentation for V2\u003c/h3\u003e\n\n\u003cp\u003eOn this page below. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"authentication\"\u003eAuthentication\u003c/h3\u003e\n\n\u003cp\u003eOAuth2 is used for authentication. \u003ca href=\"/oauth\"\u003eOAuth2 guide\u003c/a\u003e.\u003cbr /\u003e All other auth methods are deprecated and will be removed after 2018-07-01. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"restrictions\"\u003eRestrictions\u003c/h3\u003e\n\n\u003cp\u003eAPI access is limited by \u003ccode\u003e5rps\u003c/code\u003e and \u003ccode\u003e90rpm\u003c/code\u003e \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"requirements\"\u003eRequirements\u003c/h3\u003e\n\n\u003cp\u003eAdd your Oauth2 Application name to \u003ccode\u003eUser-Agent\u003c/code\u003e requests header.\u003c/p\u003e\n\n\u003cp\u003eDon’t mimic a browser.\u003c/p\u003e\n\n\u003cp\u003eYour IP address may be banned if you use API without properly set \u003ccode\u003eUser-Agent\u003c/code\u003e header. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"third_party_implementations\"\u003eThird party implementations\u003c/h3\u003e\n\n\u003cp\u003e\u003ca href=\"https://github.com/OlegWock/PyShiki\"\u003ePython API implementation\u003c/a\u003e by OlegWock.\u003c/p\u003e\n\n\u003cp\u003e\u003ca href=\"https://github.com/Capster/node-shikimori\"\u003eNode.js API implementation\u003c/a\u003e by Capster.\u003c/p\u003e\n\n\u003cp\u003e\u003ca href=\"https://github.com/JustRoxy/ShikimoriSharp\"\u003eC# API implementation\u003c/a\u003e by JustRoxy.\u003c/p\u003e\n\n\u003cp\u003e\u003ca href=\"https://github.com/iwdt/shikikit#shikimori-api\"\u003eRuby API implementation\u003c/a\u003e by iwdt. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"feedback\"\u003eFeedback\u003c/h3\u003e\n\n\u003cp\u003e\u003ca href=\"/morr\"\u003e@morr\u003c/a\u003e, \u003ca href=\"mailto:admin@shikimori.me\"\u003eemail\u003c/a\u003e \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n","copyright":null,"doc_url":"/api/doc/2.0","api_url":"/api","resources":{"abuse_requests":{"doc_url":"/api/doc/2.0/abuse_requests","id":"abuse_requests","api_url":"/api","name":"Abuse requests","short_description":null,"full_description":null,"version":"2.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/2.0/abuse_requests/offtopic","name":"offtopic","apis":[{"api_url":"/api/v2/abuse_requests/offtopic","http_method":"POST","short_description":"Mark comment as offtopic","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequest will be sent to moderators.\u003c/p\u003e\n","errors":[],"params":[{"name":"comment_id","full_name":"comment_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/v2/abuse_requests/offtopic\n{\n  \"comment_id\": \"1\"\n}\n201\n{\n  \"kind\": \"offtopic\",\n  \"value\": false,\n  \"affected_ids\": [\n    1\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/abuse_requests/convert_review","name":"convert_review","apis":[{"api_url":"/api/v2/abuse_requests/review","http_method":"POST","short_description":"Convert comment to review","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequest will be sent to moderators.\u003c/p\u003e\n","errors":[],"params":[{"name":"comment_id","full_name":"comment_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"topic_id","full_name":"topic_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/v2/abuse_requests/convert_review\n{\n  \"topic_id\": \"270100\"\n}\n200\n{}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/abuse_requests/abuse","name":"abuse","apis":[{"api_url":"/api/v2/abuse_requests/abuse","http_method":"POST","short_description":"Create abuse about violation of site rules","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequest will be sent to moderators.\u003c/p\u003e\n","errors":[],"params":[{"name":"comment_id","full_name":"comment_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"topic_id","full_name":"topic_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"reason","full_name":"reason","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/v2/abuse_requests/abuse\n{\n  \"comment_id\": \"3\",\n  \"reason\": \"zxcv\"\n}\n200\n{}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/abuse_requests/spoiler","name":"spoiler","apis":[{"api_url":"/api/v2/abuse_requests/spoiler","http_method":"POST","short_description":"Create abuse about spoiler in content","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequest will be sent to moderators.\u003c/p\u003e\n","errors":[],"params":[{"name":"comment_id","full_name":"comment_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"topic_id","full_name":"topic_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"reason","full_name":"reason","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/v2/abuse_requests/spoiler\n{\n  \"comment_id\": \"2\",\n  \"reason\": \"zxcv\"\n}\n200\n{}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"episode_notifications":{"doc_url":"/api/doc/2.0/episode_notifications","id":"episode_notifications","api_url":"/api","name":"Episode notifications","short_description":null,"full_description":null,"version":"2.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/2.0/episode_notifications/create","name":"create","apis":[{"api_url":"/api/v2/episode_notifications","http_method":"POST","short_description":"Notify shikimori about anime episode release","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"episode_notification","full_name":"episode_notification","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"anime_id","full_name":"episode_notification[anime_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"episode","full_name":"episode_notification[episode]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"aired_at","full_name":"episode_notification[aired_at]","description":"\n\u003cp\u003eEpisode release date\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a date in `iso8601` `YYYY-MM-DDThh:mm:ss±hh` format","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_fandub","full_name":"episode_notification[is_fandub]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"is_raw","full_name":"episode_notification[is_raw]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"is_subtitles","full_name":"episode_notification[is_subtitles]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"is_anime365","full_name":"episode_notification[is_anime365]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"token","full_name":"token","description":"\n\u003cp\u003ePrivate token required to access this api\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /api/v2/episode_notifications\n{\n  \"episode_notification\": {\n    \"aired_at\": \"2022-11-19T17:19:31+03:00\",\n    \"anime_id\": \"35\",\n    \"episode\": \"3\",\n    \"is_anime365\": \"true\",\n    \"is_fandub\": \"true\",\n    \"is_raw\": \"false\",\n    \"is_subtitles\": \"false\"\n  },\n  \"token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n200\n{\n  \"id\": 1,\n  \"anime_id\": 35,\n  \"episode\": 3,\n  \"is_raw\": false,\n  \"is_subtitles\": false,\n  \"is_fandub\": true,\n  \"is_anime365\": true,\n  \"topic_id\": 123\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"user_rates":{"doc_url":"/api/doc/2.0/user_rates","id":"user_rates","api_url":"/api","name":"User rates","short_description":null,"full_description":null,"version":"2.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/2.0/user_rates/index","name":"index","apis":[{"api_url":"/api/v2/user_rates","http_method":"GET","short_description":"List user rates","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"target_id","full_name":"target_id","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"target_type","full_name":"target_type","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eAnime\u003c/code\u003e, \u003ccode\u003eManga\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\u003cp\u003e\u003ccode\u003eplanned\u003c/code\u003e \u0026ndash; Planned to Watch\u003c/p\u003e\u003cp\u003e\u003ccode\u003ewatching\u003c/code\u003e \u0026ndash; Watching\u003c/p\u003e\u003cp\u003e\u003ccode\u003erewatching\u003c/code\u003e \u0026ndash; Rewatching\u003c/p\u003e\u003cp\u003e\u003ccode\u003ecompleted\u003c/code\u003e \u0026ndash; Completed\u003c/p\u003e\u003cp\u003e\u003ccode\u003eon_hold\u003c/code\u003e \u0026ndash; On Hold\u003c/p\u003e\u003cp\u003e\u003ccode\u003edropped\u003c/code\u003e \u0026ndash; Dropped\u003c/p\u003e\u003cp\u003e\u003cstrong\u003eValidations:\u003c/strong\u003e\u003c/p\u003e\u003cul\u003e\n  \u003cli\u003e\n    Must be one of:\n    \u003ccode\u003eplanned\u003c/code\u003e, \u003ccode\u003ewatching\u003c/code\u003e, \u003ccode\u003erewatching\u003c/code\u003e, \u003ccode\u003ecompleted\u003c/code\u003e, \u003ccode\u003eon_hold\u003c/code\u003e, \u003ccode\u003edropped\u003c/code\u003e\n  \u003c/li\u003e\n\u003c/ul\u003e","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eThis field is ignored when user_id is set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number between 1 and 100000.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003e1000 maximum. This field is ignored when user_id is set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/v2/user_rates\n200\n[\n  {\n    \"id\": 13,\n    \"user_id\": 23456789,\n    \"target_id\": 12,\n    \"target_type\": \"Anime\",\n    \"score\": 0,\n    \"status\": \"completed\",\n    \"rewatches\": 0,\n    \"episodes\": 0,\n    \"volumes\": 0,\n    \"chapters\": 0,\n    \"text\": null,\n    \"text_html\": \"\",\n    \"created_at\": \"2022-11-26T17:19:28.708+03:00\",\n    \"updated_at\": \"2022-11-26T17:19:28.708+03:00\"\n  },\n  {\n    \"id\": 14,\n    \"user_id\": 23456789,\n    \"target_id\": 13,\n    \"target_type\": \"Anime\",\n    \"score\": 0,\n    \"status\": \"planned\",\n    \"rewatches\": 0,\n    \"episodes\": 0,\n    \"volumes\": 0,\n    \"chapters\": 0,\n    \"text\": null,\n    \"text_html\": \"\",\n    \"created_at\": \"2022-11-26T17:19:28.708+03:00\",\n    \"updated_at\": \"2022-11-26T17:19:28.708+03:00\"\n  }\n]"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/user_rates/show","name":"show","apis":[{"api_url":"/api/v2/user_rates/:id","http_method":"GET","short_description":"Show an user rate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /api/v2/user_rates/9\n200\n{\n  \"id\": 9,\n  \"user_id\": 23456789,\n  \"target_id\": 8,\n  \"target_type\": \"Anime\",\n  \"score\": 0,\n  \"status\": \"planned\",\n  \"rewatches\": 0,\n  \"episodes\": 0,\n  \"volumes\": 0,\n  \"chapters\": 0,\n  \"text\": null,\n  \"text_html\": \"\",\n  \"created_at\": \"2022-11-26T17:19:28.554+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:28.554+03:00\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/user_rates/create","name":"create","apis":[{"api_url":"/api/v2/user_rates","http_method":"POST","short_description":"Create an user rate","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003euser_rates\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[{"name":"user_rate","full_name":"user_rate","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"user_id","full_name":"user_rate[user_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"target_id","full_name":"user_rate[target_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"target_type","full_name":"user_rate[target_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAnime\u003c/code\u003e, \u003ccode\u003eManga\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"user_rate[status]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"score","full_name":"user_rate[score]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"chapters","full_name":"user_rate[chapters]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"episodes","full_name":"user_rate[episodes]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"volumes","full_name":"user_rate[volumes]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rewatches","full_name":"user_rate[rewatches]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text","full_name":"user_rate[text]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["POST /api/v2/user_rates\n{\n  \"user_rate\": {\n    \"chapters\": \"4\",\n    \"episodes\": \"2\",\n    \"rewatches\": \"5\",\n    \"score\": \"10\",\n    \"status\": \"completed\",\n    \"target_id\": \"15\",\n    \"target_type\": \"Anime\",\n    \"text\": \"test\",\n    \"user_id\": \"23456789\",\n    \"volumes\": \"3\"\n  }\n}\n201\n{\n  \"id\": 16,\n  \"user_id\": 23456789,\n  \"target_id\": 15,\n  \"target_type\": \"Anime\",\n  \"score\": 10,\n  \"status\": \"completed\",\n  \"rewatches\": 5,\n  \"episodes\": 2,\n  \"volumes\": 3,\n  \"chapters\": 4,\n  \"text\": \"test\",\n  \"text_html\": \"test\",\n  \"created_at\": \"2022-11-26T17:19:28.773+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:28.773+03:00\"\n}","POST /api/v2/user_rates\n{\n  \"user_rate\": {\n    \"chapters\": \"4\",\n    \"episodes\": \"2\",\n    \"rewatches\": \"5\",\n    \"score\": \"10\",\n    \"status\": \"watching\",\n    \"target_id\": \"16\",\n    \"target_type\": \"Anime\",\n    \"text\": \"test\",\n    \"user_id\": \"23456789\",\n    \"volumes\": \"3\"\n  }\n}\n201\n{\n  \"id\": 17,\n  \"user_id\": 23456789,\n  \"target_id\": 16,\n  \"target_type\": \"Anime\",\n  \"score\": 10,\n  \"status\": \"watching\",\n  \"rewatches\": 5,\n  \"episodes\": 2,\n  \"volumes\": 3,\n  \"chapters\": 4,\n  \"text\": \"test\",\n  \"text_html\": \"test\",\n  \"created_at\": \"2022-11-26T17:19:28.814+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:28.814+03:00\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/user_rates/update","name":"update","apis":[{"api_url":"/api/v2/user_rates/:id","http_method":"PATCH","short_description":"Update an user rate","deprecated":null},{"api_url":"/api/v2/user_rates/:id","http_method":"PUT","short_description":"Update an user rate","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003euser_rates\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[{"name":"user_rate","full_name":"user_rate","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"status","full_name":"user_rate[status]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"score","full_name":"user_rate[score]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"chapters","full_name":"user_rate[chapters]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"episodes","full_name":"user_rate[episodes]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"volumes","full_name":"user_rate[volumes]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rewatches","full_name":"user_rate[rewatches]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":null,"expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"text","full_name":"user_rate[text]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["PATCH /api/v2/user_rates/12\n{\n  \"user_rate\": {\n    \"chapters\": \"4\",\n    \"episodes\": \"2\",\n    \"rewatches\": \"5\",\n    \"score\": \"10\",\n    \"status\": \"watching\",\n    \"text\": \"test\",\n    \"volumes\": \"3\"\n  }\n}\n200\n{\n  \"id\": 12,\n  \"user_id\": 23456789,\n  \"target_id\": 11,\n  \"target_type\": \"Anime\",\n  \"score\": 10,\n  \"status\": \"watching\",\n  \"rewatches\": 5,\n  \"episodes\": 2,\n  \"volumes\": 3,\n  \"chapters\": 4,\n  \"text\": \"test\",\n  \"text_html\": \"test\",\n  \"created_at\": \"2022-11-26T17:19:28.660+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:28.660+03:00\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/user_rates/increment","name":"increment","apis":[{"api_url":"/api/v2/user_rates/:id/increment","http_method":"POST","short_description":"Increment episodes/chapters by 1","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003euser_rates\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["POST /api/v2/user_rates/11/increment\n{}\n201\n{\n  \"id\": 11,\n  \"user_id\": 23456789,\n  \"target_id\": 10,\n  \"target_type\": \"Anime\",\n  \"score\": 0,\n  \"status\": \"planned\",\n  \"rewatches\": 0,\n  \"episodes\": 2,\n  \"volumes\": 0,\n  \"chapters\": 0,\n  \"text\": null,\n  \"text_html\": \"\",\n  \"created_at\": \"2022-11-26T17:19:28.620+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:28.620+03:00\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/user_rates/destroy","name":"destroy","apis":[{"api_url":"/api/v2/user_rates/:id","http_method":"DELETE","short_description":"Destroy an user rate","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003euser_rates\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["DELETE /api/v2/user_rates/10\n{}\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"Topic Ignore":{"doc_url":"/api/doc/2.0/Topic Ignore","id":"Topic Ignore","api_url":"/api","name":"Topic ignore","short_description":null,"full_description":"","version":"2.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/2.0/Topic Ignore/create","name":"create","apis":[{"api_url":"/api/v2/topics/:topic_id/ignore","http_method":"POST","short_description":"Ignore a topic","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003etopics\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["POST /api/v2/topics/82468/ignore\n{}\n200\n{\n  \"topic_id\": \"82468\",\n  \"is_ignored\": true\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/Topic Ignore/destroy","name":"destroy","apis":[{"api_url":"/api/v2/topics/:topic_id/ignore","http_method":"DELETE","short_description":"Unignore a topic","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003etopics\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["DELETE /api/v2/topics/82468/ignore\n{}\n200\n{\n  \"topic_id\": \"82468\",\n  \"is_ignored\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"User Ignore":{"doc_url":"/api/doc/2.0/User Ignore","id":"User Ignore","api_url":"/api","name":"User ignore","short_description":null,"full_description":"","version":"2.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/2.0/User Ignore/create","name":"create","apis":[{"api_url":"/api/v2/users/:user_id/ignore","http_method":"POST","short_description":"Ignore a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003eignores\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["POST /api/v2/users/23456795/ignore\n{}\n200\n{\n  \"user_id\": \"23456795\",\n  \"is_ignored\": true\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/2.0/User Ignore/destroy","name":"destroy","apis":[{"api_url":"/api/v2/users/:user_id/ignore","http_method":"DELETE","short_description":"Unignore a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003eignores\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["DELETE /api/v2/users/23456794/ignore\n{}\n200\n{\n  \"user_id\": \"23456794\",\n  \"is_ignored\": false\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}