{"id":26508381,"url":"https://github.com/spiralmoon/maplestory.openapi","last_synced_at":"2026-04-01T19:32:43.728Z","repository":{"id":207824761,"uuid":"718741682","full_name":"SpiralMoon/maplestory.openapi","owner":"SpiralMoon","description":"🍁 MapleStory Nexon Open API Client Library for TypeScript, Java, C#, Python. KMS, MSEA is now available!🍁","archived":false,"fork":false,"pushed_at":"2025-08-21T00:34:35.000Z","size":1429,"stargazers_count":31,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-21T02:36:00.583Z","etag":null,"topics":["csharp","java","javascript","kms","library","maplestroy","msea","nexon-openpai","openapi","package","python","sdk","typescript"],"latest_commit_sha":null,"homepage":"https://openapi.nexon.com/ko/game/maplestory/?id=14","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpiralMoon.png","metadata":{"files":{"readme":"README-en.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-11-14T17:53:10.000Z","updated_at":"2025-08-08T07:00:13.000Z","dependencies_parsed_at":"2024-02-10T17:28:25.073Z","dependency_job_id":"48d5f6db-c0a2-4521-8252-62cb67c8ad82","html_url":"https://github.com/SpiralMoon/maplestory.openapi","commit_stats":null,"previous_names":["spiralmoon/maplestory.openapi"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/SpiralMoon/maplestory.openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpiralMoon%2Fmaplestory.openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpiralMoon%2Fmaplestory.openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpiralMoon%2Fmaplestory.openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpiralMoon%2Fmaplestory.openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpiralMoon","download_url":"https://codeload.github.com/SpiralMoon/maplestory.openapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpiralMoon%2Fmaplestory.openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271998585,"owners_count":24856066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","java","javascript","kms","library","maplestroy","msea","nexon-openpai","openapi","package","python","sdk","typescript"],"created_at":"2025-03-21T00:23:31.817Z","updated_at":"2026-04-01T19:32:43.453Z","avatar_url":"https://github.com/SpiralMoon.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"[한국어](./README.md) | English\n\n[![GitHub contributors](https://img.shields.io/github/contributors/SpiralMoon/maplestory.openapi.svg)](https://github.com/SpiralMoon/maplestory.openapi/graphs/contributors)\n[![GitHub issues](https://img.shields.io/github/issues/SpiralMoon/maplestory.openapi.svg)](https://github.com/SpiralMoon/maplestory.openapi/issues)\n[![GitHub stars](https://img.shields.io/github/stars/SpiralMoon/maplestory.openapi.svg)](https://github.com/SpiralMoon/maplestory.openapi/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/SpiralMoon/maplestory.openapi.svg)](https://github.com/SpiralMoon/maplestory.openapi/network/members)\n[![GitHub license](https://img.shields.io/github/license/SpiralMoon/maplestory.openapi.svg)](https://github.com/SpiralMoon/maplestory.openapi/blob/master/LICENSE)\n\n[![npm](https://img.shields.io/npm/v/maplestory-openapi)](https://www.npmjs.com/package/maplestory-openapi)\n[![Maven Central](https://img.shields.io/maven-central/v/dev.spiralmoon/maplestory-openapi)](https://search.maven.org/artifact/dev.spiralmoon/maplestory-openapi)\n[![NuGet](https://img.shields.io/nuget/v/MapleStory.OpenAPI)](https://www.nuget.org/packages/MapleStory.OpenAPI)\n[![PyPi](https://img.shields.io/pypi/v/maplestory-openapi)](https://pypi.org/project/maplestory-openapi)\n\n[![JS](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/js_test.yaml/badge.svg)](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/js_test.yaml)\n[![Java](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/java_test.yaml/badge.svg)](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/java_test.yaml)\n[![C#](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/csharp_test.yaml/badge.svg)](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/csharp_test.yaml)\n[![Python](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/python_test.yaml/badge.svg)](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/python_test.yaml)\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./logo.png\" width=\"120\" height=\"120\"/\u003e\n\u003c/div\u003e\n\u003ch1 align=\"center\"\u003e🍁 MapleStory OpenAPI Library 🍁\u003c/h1\u003e\n\u003cp align=\"center\"\u003eThis library project enables the use of the MapleStory OpenAPI of Nexon.\u003c/p\u003e\n\n\u003e💻 This library is maintained in sync with Nexon OpenAPI patches. It is recommended to always use the latest version.\n\u003e \n\u003e 🌏 Notice 1: Starting from version 3.0.0, support for multiple service regions has been added. You can now retrieve data from [KMS](https://maplestory.nexon.com/) and [MSEA](http://www.maplesea.com/index/).\n\u003e \n\u003e 💡 Notice 2: Migration is required when updating from version 2.x.x to 3.0.0. Please refer to the documentation for details.\n\n## Supported\n### Languages\n\u003cdiv align=\"center\"\u003e\n    \u003ctable\u003e\n      \u003ctr\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://www.npmjs.com/package/maplestory-openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg\" alt=\"javascript\" width=\"40\" height=\"40\"/\u003e\n          \u003c/a\u003e\n          \u003ca href=\"https://www.npmjs.com/package/maplestory-openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg\" alt=\"typescript\" width=\"40\" height=\"40\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://search.maven.org/artifact/dev.spiralmoon/maplestory-openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://raw.githubusercontent.com/devicons/devicon/master/icons/java/java-original.svg\" alt=\"java\" width=\"40\" height=\"40\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://www.nuget.org/packages/MapleStory.OpenAPI\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://raw.githubusercontent.com/devicons/devicon/master/icons/csharp/csharp-original.svg\" alt=\"csharp\" width=\"40\" height=\"40\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://pypi.org/project/maplestory_openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg\" alt=\"python\" width=\"40\" height=\"40\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n      \u003c/tr\u003e\n      \u003ctr\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://www.npmjs.com/package/maplestory-openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/npm/v/maplestory-openapi?label=\" alt=\"typescript\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://search.maven.org/artifact/dev.spiralmoon/maplestory-openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/maven-central/v/dev.spiralmoon/maplestory-openapi?label=\" alt=\"csharp\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://www.nuget.org/packages/MapleStory.OpenAPI\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/nuget/v/MapleStory.OpenAPI?label=\" alt=\"java\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://pypi.org/project/maplestory_openapi\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/pypi/v/maplestory-openapi?label=\" alt=\"python\"/\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n      \u003c/tr\u003e\n    \u003c/table\u003e\n\u003c/div\u003e\n\nThis library project is concurrently provided in various languages, including JavaScript(TypeScript), Java, C#, Python, and more, and is available on package repositories.\n\n### Regions\n\u003cdiv align=\"center\"\u003e\n    \u003ctable\u003e\n      \u003ctr\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://maplestory.nexon.com/\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://upload.wikimedia.org/wikipedia/ko/thumb/8/8a/MapleStory_logo.png/250px-MapleStory_logo.png\" alt=\"KMS\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://www.nexon.com/maplestory/\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://i.namu.wiki/i/-WKuX88iUEMC9-Lh5aRpA_pjgxZGmagDkhoyYLwBlxG-o60NbBlIG0B-dTXRRAO2cfSthfgBAav6X9AQOVZo69F3cr_ZvltIQ2TIwM5e0y380snj8jh_6UmDFV3u4mIPx9qv7I8mdbnZ5RJnVFCmwA.webp\" alt=\"GMS\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://maplestory.nexon.co.jp/\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://i.namu.wiki/i/co2Bfq0sjQPN-9FLFHuMzZIpXKj4QgtJx7gmH_REucvs70wVJ07YT7i89Yuk4pbpDW2a7r9dPJ7ShtVxKw-DzNwNA4E23gpVLz1DmZZsN_wqjkI5zYQ41gNzCOYE7QVGCz8AndqU7Q7YfkKl6BwMBg.webp\" alt=\"JMS\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n      \u003c/tr\u003e\n      \u003ctr\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://openapi.nexon.com/ko/game/maplestory/?id=14\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/KMS-support-green\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/GMS-not_supported-red\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/JMS-not_supported-red\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n      \u003c/tr\u003e\n      \u003ctr\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"http://www.maplesea.com/index\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://media.playpark.net/pp/intro/images/msea_logo_w.png\" alt=\"MSEA\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"http://maplestory.beanfun.com/\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://i.namu.wiki/i/UrML691KGq0k-HJYmrhRUlbgIGbO376uQWCwHiXmOUytxQyZMCFWPmdy4Lo5TXr3AoZ0ivireTjzu0WrzUuVw1Gg2rlI8x1P6Crz6KABCln_1fGkQ3J2uLeAjhiFr6mY8oPAA4QjnRoyVZEc-lQZ2g.webp\" alt=\"TMS\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://mxd.web.sdo.com/web7/home/index.html\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://i.namu.wiki/i/GkTPEQ8mkux1qZrMqFn_xcI_mA34L1rEKXM1gbGkJJaGZBn2hXcNKpy4PDYOhrwFJ7jhV_M-JwP6PLlIP9dPNg6jlXxSbpQ272ODLjQyJ4Mj2QUKI328NWEaipZGYLUgeN6i15fy-3StKgJWVyqOIA.webp\" alt=\"CMS\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n      \u003c/tr\u003e\n      \u003ctr\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca href=\"https://openapi.nexon.com/en/game/maplestorysea/?id=45\" target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/MSEA-support-green\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/TMS-not_supported-red\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n          \u003ca target=\"_blank\" rel=\"noreferrer\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/CMS-not_supported-red\" /\u003e\n          \u003c/a\u003e\n        \u003c/td\u003e\n      \u003c/tr\u003e\n    \u003c/table\u003e\n\u003c/div\u003e\n\nThis library can only retrieve data from the service regions supported by the Nexon Open API. If Nexon releases an API for a new region, this project plans to support it as well.\n\n## Documentation\nBefore getting started, please read the document in the README list below that matches your development environment.\n\n- Go to read [**JavaScript(TypeScript)** document](./js/README-en.md).\n- Go to read [**Java** document](./java/README-en.md).\n- Go to read [**C#** document](./csharp/README-en.md).\n- Go to read [**Python** document](./python/README-en.md).\n\n## Features\nThis library supports all apis published in the [MapleStory OpenAPI official docs](https://openapi.nexon.com/game/maplestory) link below.\n\n- [Get character information](https://openapi.nexon.com/ko/game/maplestory/?id=14)\n- [Get union information](https://openapi.nexon.com/ko/game/maplestory/?id=15)\n- [Get guild information](https://openapi.nexon.com/ko/game/maplestory/?id=16)\n- [Get history information](https://openapi.nexon.com/ko/game/maplestory/?id=17)\n- [Get ranking information](https://openapi.nexon.com/ko/game/maplestory/?id=18)\n- [Get notice information](https://openapi.nexon.com/ko/game/maplestory/?id=24)\n\nAnd, while not part of the MapleStory OpenAPI specifications, it additionally supports the following API.\n\n- [Get server inspection information](https://api.maplestory.nexon.com/soap/maplestory.asmx?op=GetInspectionInfo)\n\n## Release note\n1. The main changes to this library are documented in the [release notes](https://github.com/SpiralMoon/maplestory.openapi/releases).\n2. Migration is required during major version updates. Please refer to the documentation for each package.\n\n## Contributors\n\u003ca href=\"https://github.com/SpiralMoon/maplestory.openapi/graphs/contributors\"\u003e\n    \u003cimg src=\"https://contrib.rocks/image?repo=SpiralMoon/maplestory.openapi\" /\u003e\n\u003c/a\u003e\n\nThis project exists thanks to all the people who contribute.\n\nContributions from other developers are welcome! Feel free to contribute by submitting pull requests.\n\nPlease give us a ⭐ star ⭐ to support us. Thank you.💖\n\n## Additional Information\n\n1. The implementation details of the API are documented on the [MapleStory OpenAPI spec](https://openapi.nexon.com/game/maplestory). Refer to the documentation for each language.\n2. This library adheres to language-specific naming style guides, resulting in slight differences from the naming conventions in the official documentation. ex) 'cube_history' -\u003e 'cubeHistory'\n3. The comments for the methods and properties provided by this library are synchronized with the official documentation.\n4. This library is nonofficial.\n5. Data based on [NEXON Open API](https://openapi.nexon.com)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspiralmoon%2Fmaplestory.openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspiralmoon%2Fmaplestory.openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspiralmoon%2Fmaplestory.openapi/lists"}