{"docs":{"name":"Shikimori API","info":"\n\u003ch2 id=\"welcome_to_shikimori_api_v1\"\u003eWelcome to Shikimori API v1\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\u003eOn this page below. \u003cbr /\u003e\u003cbr /\u003e\u003c/p\u003e\n\n\u003ch3 id=\"documentation_for_v2\"\u003eDocumentation for V2\u003c/h3\u003e\n\n\u003cp\u003e\u003ca href=\"/api/doc/2.0.html\"\u003eClick here\u003c/a\u003e. \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=\"pagination_in_api\"\u003ePagination in API\u003c/h3\u003e\n\n\u003cp\u003eWhen you request \u003ccode\u003eN\u003c/code\u003e elements from paginated API, in most cases you will get \u003ccode\u003eN+1\u003c/code\u003e results if API has next page. \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/1.0","api_url":"/api","resources":[{"doc_url":"/api/doc/1.0/comments","id":"comments","api_url":"/api","name":"Comments","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/1.0/comments/index","name":"index","apis":[{"api_url":"/api/comments","http_method":"GET","short_description":"List comments","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"commentable_id","full_name":"commentable_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"commentable_type","full_name":"commentable_type","description":"\n\u003cp\u003eMust be one of: \u003ccode\u003eTopic\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTopic\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"","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\u003e30 maximum\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":[]},{"name":"desc","full_name":"desc","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /api/comments\n200\n[\n  {\n    \"id\": 15,\n    \"user_id\": 23456789,\n    \"commentable_id\": 23456821,\n    \"commentable_type\": \"User\",\n    \"body\": \"comment_body_14\",\n    \"html_body\": \"comment_body_14\",\n    \"created_at\": \"2022-11-26T17:19:31.881+03:00\",\n    \"updated_at\": \"2022-11-26T17:19:31.881+03:00\",\n    \"is_offtopic\": false,\n    \"is_summary\": false,\n    \"can_be_edited\": false,\n    \"user\": {\n      \"id\": 23456789,\n      \"nickname\": \"user_user\",\n      \"avatar\": \"/assets/globals/missing_avatar/x48.png\",\n      \"image\": {\n        \"x160\": \"/assets/globals/missing_avatar/x160.png\",\n        \"x148\": \"/assets/globals/missing_avatar/x148.png\",\n        \"x80\": \"/assets/globals/missing_avatar/x80.png\",\n        \"x64\": \"/assets/globals/missing_avatar/x64.png\",\n        \"x48\": \"/assets/globals/missing_avatar/x48.png\",\n        \"x32\": \"/assets/globals/missing_avatar/x32.png\",\n        \"x16\": \"/assets/globals/missing_avatar/x16.png\"\n      },\n      \"last_online_at\": \"2022-11-26T17:19:26.755+03:00\",\n      \"url\": \"http://test.host/user_user\"\n    }\n  },\n  {\n    \"id\": 14,\n    \"user_id\": 23456789,\n    \"commentable_id\": 23456821,\n    \"commentable_type\": \"User\",\n    \"body\": \"comment_body_13\",\n    \"html_body\": \"comment_body_13\",\n    \"created_at\": \"2022-11-26T17:19:31.881+03:00\",\n    \"updated_at\": \"2022-11-26T17:19:31.881+03:00\",\n    \"is_offtopic\": false,\n    \"is_summary\": false,\n    \"can_be_edited\": false,\n    \"user\": {\n      \"id\": 23456789,\n      \"nickname\": \"user_user\",\n      \"avatar\": \"/assets/globals/missing_avatar/x48.png\",\n      \"image\": {\n        \"x160\": \"/assets/globals/missing_avatar/x160.png\",\n        \"x148\": \"/assets/globals/missing_avatar/x148.png\",\n        \"x80\": \"/assets/globals/missing_avatar/x80.png\",\n        \"x64\": \"/assets/globals/missing_avatar/x64.png\",\n        \"x48\": \"/assets/globals/missing_avatar/x48.png\",\n        \"x32\": \"/assets/globals/missing_avatar/x32.png\",\n        \"x16\": \"/assets/globals/missing_avatar/x16.png\"\n      },\n      \"last_online_at\": \"2022-11-26T17:19:26.755+03:00\",\n      \"url\": \"http://test.host/user_user\"\n    }\n  }\n]"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/1.0/comments/show","name":"show","apis":[{"api_url":"/api/comments/:id","http_method":"GET","short_description":"Show a comment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /api/comments/11\n200\n{\n  \"id\": 11,\n  \"user_id\": 23456818,\n  \"commentable_id\": 270117,\n  \"commentable_type\": \"Topic\",\n  \"body\": \"comment_body_11\",\n  \"html_body\": \"comment_body_11\",\n  \"created_at\": \"2022-11-26T17:19:31.633+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:31.633+03:00\",\n  \"is_offtopic\": false,\n  \"is_summary\": false,\n  \"can_be_edited\": false,\n  \"user\": {\n    \"id\": 23456818,\n    \"nickname\": \"zxc\",\n    \"avatar\": \"/assets/globals/missing_avatar/x48.png\",\n    \"image\": {\n      \"x160\": \"/assets/globals/missing_avatar/x160.png\",\n      \"x148\": \"/assets/globals/missing_avatar/x148.png\",\n      \"x80\": \"/assets/globals/missing_avatar/x80.png\",\n      \"x64\": \"/assets/globals/missing_avatar/x64.png\",\n      \"x48\": \"/assets/globals/missing_avatar/x48.png\",\n      \"x32\": \"/assets/globals/missing_avatar/x32.png\",\n      \"x16\": \"/assets/globals/missing_avatar/x16.png\"\n    },\n    \"last_online_at\": \"2022-11-26T17:19:31.633+03:00\",\n    \"url\": \"http://test.host/zxc\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/1.0/comments/create","name":"create","apis":[{"api_url":"/api/comments","http_method":"POST","short_description":"Create a comment","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003ecomments\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"body","full_name":"comment[body]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"commentable_id","full_name":"comment[commentable_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"commentable_type","full_name":"comment[commentable_type]","description":"\u003cp\u003e Must be one of: \u003ccode\u003eTopic\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eAnime\u003c/code\u003e, \u003ccode\u003eManga\u003c/code\u003e, \u003ccode\u003eCharacter\u003c/code\u003e, \u003ccode\u003ePerson\u003c/code\u003e, \u003ccode\u003eArticle\u003c/code\u003e, \u003ccode\u003eClub\u003c/code\u003e, \u003ccode\u003eClubPage\u003c/code\u003e, \u003ccode\u003eCollection\u003c/code\u003e, \u003ccode\u003eCritique\u003c/code\u003e, \u003ccode\u003eReview\u003c/code\u003e \u003c/p\u003e\u003cp\u003e When set to \u003ccode\u003eAnime\u003c/code\u003e, \u003ccode\u003eManga\u003c/code\u003e, \u003ccode\u003eCharacter\u003c/code\u003e, \u003ccode\u003ePerson\u003c/code\u003e, \u003ccode\u003eArticle\u003c/code\u003e, \u003ccode\u003eClub\u003c/code\u003e, \u003ccode\u003eClubPage\u003c/code\u003e, \u003ccode\u003eCollection\u003c/code\u003e, \u003ccode\u003eCritique\u003c/code\u003e, \u003ccode\u003eReview\u003c/code\u003e comment is attached to \u003ccode\u003ecommentable\u003c/code\u003e main topic \u003c/p\u003e","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eTopic\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eAnime\u003c/code\u003e, \u003ccode\u003eManga\u003c/code\u003e, \u003ccode\u003eCharacter\u003c/code\u003e, \u003ccode\u003ePerson\u003c/code\u003e, \u003ccode\u003eArticle\u003c/code\u003e, \u003ccode\u003eClub\u003c/code\u003e, \u003ccode\u003eClubPage\u003c/code\u003e, \u003ccode\u003eCollection\u003c/code\u003e, \u003ccode\u003eCritique\u003c/code\u003e, \u003ccode\u003eReview\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_offtopic","full_name":"comment[is_offtopic]","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":"frontend","full_name":"frontend","description":"\n\u003cp\u003eUsed by shikimori frontend code. Ignore it.\u003c/p\u003e\n","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":"broadcast","full_name":"broadcast","description":"\n\u003cp\u003eUsed to broadcast comment in club’s topic. Only club admins can broadcast.\u003c/p\u003e\n","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":[]}],"returns":[],"examples":["POST /api/comments\n{\n  \"broadcast\": \"false\",\n  \"comment\": {\n    \"body\": \"xx\",\n    \"commentable_id\": \"270119\",\n    \"commentable_type\": \"Topic\",\n    \"is_offtopic\": \"true\"\n  },\n  \"frontend\": \"false\"\n}\n201\n{\n  \"id\": 13,\n  \"user_id\": 23456820,\n  \"commentable_id\": 270119,\n  \"commentable_type\": \"Topic\",\n  \"body\": \"xx\",\n  \"html_body\": \"xx\",\n  \"created_at\": \"2022-11-26T17:19:31.770+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:31.770+03:00\",\n  \"is_offtopic\": true,\n  \"is_summary\": false,\n  \"can_be_edited\": true,\n  \"user\": {\n    \"id\": 23456820,\n    \"nickname\": \"zxc\",\n    \"avatar\": \"/assets/globals/missing_avatar/x48.png\",\n    \"image\": {\n      \"x160\": \"/assets/globals/missing_avatar/x160.png\",\n      \"x148\": \"/assets/globals/missing_avatar/x148.png\",\n      \"x80\": \"/assets/globals/missing_avatar/x80.png\",\n      \"x64\": \"/assets/globals/missing_avatar/x64.png\",\n      \"x48\": \"/assets/globals/missing_avatar/x48.png\",\n      \"x32\": \"/assets/globals/missing_avatar/x32.png\",\n      \"x16\": \"/assets/globals/missing_avatar/x16.png\"\n    },\n    \"last_online_at\": \"2022-11-26T17:19:31.770+03:00\",\n    \"url\": \"http://test.host/zxc\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/1.0/comments/update","name":"update","apis":[{"api_url":"/api/comments/:id","http_method":"PATCH","short_description":"Update a comment","deprecated":null},{"api_url":"/api/comments/:id","http_method":"PUT","short_description":"Update a comment","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003ecomments\u003c/code\u003e oauth scope. Use \u003ccode\u003e/api/v2/abuse_requests\u003c/code\u003e to change \u003ccode\u003eis_offtopic\u003c/code\u003e field.\u003c/p\u003e\n","errors":[],"params":[{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"body","full_name":"comment[body]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"frontend","full_name":"frontend","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":[]}],"returns":[],"examples":["PATCH /api/comments/12\n{\n  \"comment\": {\n    \"body\": \"blablabla\"\n  },\n  \"frontend\": \"false\"\n}\n200\n{\n  \"id\": 12,\n  \"user_id\": 23456819,\n  \"commentable_id\": 270118,\n  \"commentable_type\": \"Topic\",\n  \"body\": \"blablabla\",\n  \"html_body\": \"blablabla\",\n  \"created_at\": \"2022-11-26T17:19:31.675+03:00\",\n  \"updated_at\": \"2022-11-26T17:19:31.675+03:00\",\n  \"is_offtopic\": false,\n  \"is_summary\": false,\n  \"can_be_edited\": true,\n  \"user\": {\n    \"id\": 23456819,\n    \"nickname\": \"zxc\",\n    \"avatar\": \"/assets/globals/missing_avatar/x48.png\",\n    \"image\": {\n      \"x160\": \"/assets/globals/missing_avatar/x160.png\",\n      \"x148\": \"/assets/globals/missing_avatar/x148.png\",\n      \"x80\": \"/assets/globals/missing_avatar/x80.png\",\n      \"x64\": \"/assets/globals/missing_avatar/x64.png\",\n      \"x48\": \"/assets/globals/missing_avatar/x48.png\",\n      \"x32\": \"/assets/globals/missing_avatar/x32.png\",\n      \"x16\": \"/assets/globals/missing_avatar/x16.png\"\n    },\n    \"last_online_at\": \"2022-11-26T17:19:31.675+03:00\",\n    \"url\": \"http://test.host/zxc\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/1.0/comments/destroy","name":"destroy","apis":[{"api_url":"/api/comments/:id","http_method":"DELETE","short_description":"Destroy a comment","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003ecomments\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["DELETE /api/comments/10\n{}\n200\n{\n  \"notice\": \"Комментарий удалён\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}]}}