https://github.com/spiralmoon/maplestory.openapi
🍁 MapleStory Nexon Open API Client Library for TypeScript, Java, C#, Python. KMS, MSEA is now available!🍁
https://github.com/spiralmoon/maplestory.openapi
csharp java javascript kms library maplestroy msea nexon-openpai openapi package python sdk typescript
Last synced: 5 months ago
JSON representation
🍁 MapleStory Nexon Open API Client Library for TypeScript, Java, C#, Python. KMS, MSEA is now available!🍁
- Host: GitHub
- URL: https://github.com/spiralmoon/maplestory.openapi
- Owner: SpiralMoon
- License: mit
- Created: 2023-11-14T17:53:10.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-08-21T00:34:35.000Z (5 months ago)
- Last Synced: 2025-08-21T02:36:00.583Z (5 months ago)
- Topics: csharp, java, javascript, kms, library, maplestroy, msea, nexon-openpai, openapi, package, python, sdk, typescript
- Language: C#
- Homepage: https://openapi.nexon.com/ko/game/maplestory/?id=14
- Size: 1.36 MB
- Stars: 31
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README-en.md
- License: LICENSE
Awesome Lists containing this project
README
[한국어](./README.md) | English
[](https://github.com/SpiralMoon/maplestory.openapi/graphs/contributors)
[](https://github.com/SpiralMoon/maplestory.openapi/issues)
[](https://github.com/SpiralMoon/maplestory.openapi/stargazers)
[](https://github.com/SpiralMoon/maplestory.openapi/network/members)
[](https://github.com/SpiralMoon/maplestory.openapi/blob/master/LICENSE)
[](https://www.npmjs.com/package/maplestory-openapi)
[](https://search.maven.org/artifact/dev.spiralmoon/maplestory-openapi)
[](https://www.nuget.org/packages/MapleStory.OpenAPI)
[](https://pypi.org/project/maplestory-openapi)
[](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/js_test.yaml)
[](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/java_test.yaml)
[](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/csharp_test.yaml)
[](https://github.com/SpiralMoon/maplestory.openapi/actions/workflows/python_test.yaml)
🍁 MapleStory OpenAPI Library 🍁
This library project enables the use of the MapleStory OpenAPI of Nexon.
>💻 This library is maintained in sync with Nexon OpenAPI patches. It is recommended to always use the latest version.
>
> 🌏 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/).
>
> 💡 Notice 2: Migration is required when updating from version 2.x.x to 3.0.0. Please refer to the documentation for details.
## Supported
### Languages
This library project is concurrently provided in various languages, including JavaScript(TypeScript), Java, C#, Python, and more, and is available on package repositories.
### Regions
This 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.
## Documentation
Before getting started, please read the document in the README list below that matches your development environment.
- Go to read [**JavaScript(TypeScript)** document](./js/README-en.md).
- Go to read [**Java** document](./java/README-en.md).
- Go to read [**C#** document](./csharp/README-en.md).
- Go to read [**Python** document](./python/README-en.md).
## Features
This library supports all apis published in the [MapleStory OpenAPI official docs](https://openapi.nexon.com/game/maplestory) link below.
- [Get character information](https://openapi.nexon.com/ko/game/maplestory/?id=14)
- [Get union information](https://openapi.nexon.com/ko/game/maplestory/?id=15)
- [Get guild information](https://openapi.nexon.com/ko/game/maplestory/?id=16)
- [Get history information](https://openapi.nexon.com/ko/game/maplestory/?id=17)
- [Get ranking information](https://openapi.nexon.com/ko/game/maplestory/?id=18)
- [Get notice information](https://openapi.nexon.com/ko/game/maplestory/?id=24)
And, while not part of the MapleStory OpenAPI specifications, it additionally supports the following API.
- [Get server inspection information](https://api.maplestory.nexon.com/soap/maplestory.asmx?op=GetInspectionInfo)
## Release note
1. The main changes to this library are documented in the [release notes](https://github.com/SpiralMoon/maplestory.openapi/releases).
2. Migration is required during major version updates. Please refer to the documentation for each package.
## Contributors
This project exists thanks to all the people who contribute.
Contributions from other developers are welcome! Feel free to contribute by submitting pull requests.
Please give us a ⭐ star ⭐ to support us. Thank you.💖
## Additional Information
1. 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.
2. This library adheres to language-specific naming style guides, resulting in slight differences from the naming conventions in the official documentation. ex) 'cube_history' -> 'cubeHistory'
3. The comments for the methods and properties provided by this library are synchronized with the official documentation.
4. This library is nonofficial.
5. Data based on [NEXON Open API](https://openapi.nexon.com)
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.