{"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/dialogs","id":"dialogs","api_url":"/api","name":"Dialogs","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/doc/1.0/dialogs/index","name":"index","apis":[{"api_url":"/api/dialogs","http_method":"GET","short_description":"List dialogs","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003emessages\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /api/dialogs\n200\n[\n  {\n    \"target_user\": {\n      \"id\": 23456830,\n      \"nickname\": \"user_12\",\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:33.176+03:00\",\n      \"url\": \"http://test.host/user_12\"\n    },\n    \"message\": {\n      \"id\": 20,\n      \"kind\": \"Private\",\n      \"read\": false,\n      \"body\": \"test\",\n      \"html_body\": \"test\",\n      \"created_at\": \"2022-11-26T17:19:33.176+03:00\",\n      \"linked_id\": 0,\n      \"linked_type\": null,\n      \"linked\": null\n    }\n  }\n]"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/1.0/dialogs/show","name":"show","apis":[{"api_url":"/api/dialogs/:id","http_method":"GET","short_description":"Show a dialog","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003emessages\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["GET /api/dialogs/user_11\n200\n[\n  {\n    \"id\": 19,\n    \"kind\": \"Private\",\n    \"read\": false,\n    \"body\": \"test\",\n    \"html_body\": \"test\",\n    \"created_at\": \"2022-11-26T17:19:33.124+03:00\",\n    \"linked_id\": 0,\n    \"linked_type\": null,\n    \"linked\": null,\n    \"from\": {\n      \"id\": 23456829,\n      \"nickname\": \"user_11\",\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:33.124+03:00\",\n      \"url\": \"http://test.host/user_11\"\n    },\n    \"to\": {\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\": 18,\n    \"kind\": \"Private\",\n    \"read\": false,\n    \"body\": \"test\",\n    \"html_body\": \"test\",\n    \"created_at\": \"2022-11-26T17:19:33.124+03:00\",\n    \"linked_id\": 0,\n    \"linked_type\": null,\n    \"linked\": null,\n    \"from\": {\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    \"to\": {\n      \"id\": 23456829,\n      \"nickname\": \"user_11\",\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:33.124+03:00\",\n      \"url\": \"http://test.host/user_11\"\n    }\n  }\n]"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/doc/1.0/dialogs/destroy","name":"destroy","apis":[{"api_url":"/api/dialogs/:id","http_method":"DELETE","short_description":"Destroy a dialog","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRequires \u003ccode\u003emessages\u003c/code\u003e oauth scope\u003c/p\u003e\n","errors":[{"code":422,"description":null,"metadata":null}],"params":[],"returns":[],"examples":["DELETE /api/dialogs/user_13\n{}\n200\n{\n  \"notice\": \"Переписка удалена\"\n}","DELETE /api/dialogs/user_14\n{}\n422\n[\n  \"Не найдено ни одного сообщения для удаления\"\n]"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}]}}