νκ΅μ΄ | English
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.4.0, support for tms region has been added. You can now retrieve data from KMS, TMS, MSEA.
π Notice 2: Starting from version 3.0.0, support for msea region has been added.
π‘ Notice 2: Migration is required when updating from version 2.x.x to 3.0.0. Please refer to the documentation for details.
|
|
|
|
|
|
|
|
This library project is concurrently provided in various languages, including JavaScript(TypeScript), Java, C#, Python, and more, and is available on package repositories.
|
|
|
|
|
|
|
|
|
|
|
|
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.
Before getting started, please read the document in the README list below that matches your development environment.
- Go to read JavaScript(TypeScript) document.
- Go to read Java document.
- Go to read C# document.
- Go to read Python document.
This library supports all apis published in the MapleStory OpenAPI official docs.
- Character Information Retrieval
- Union Information Retrieval
- Guild Information Retrieval
- History Information Retrieval
- Ranking Information Retrieval
- Notice Information Retrieval
Some features are supported only in specific regions. Please refer to the official documentation for each region for details.
- KMS: https://openapi.nexon.com/game/maplestory
- TMS: https://openapi.nexon.com/game/maplestorytw
- MSEA: https://openapi.nexon.com/game/maplestorysea
And, while not part of the MapleStory OpenAPI specifications, it additionally supports the following API.
- The main changes to this library are documented in the release notes.
- Migration is required during major version updates. Please refer to the documentation for each package.
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.π
- The implementation details of the API are documented on the MapleStory OpenAPI spec. Refer to the documentation for each language.
- 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'
- The comments for the methods and properties provided by this library are synchronized with the official documentation.
- This library is nonofficial.
- Data based on NEXON Open API
This project is licensed under the MIT License - see the LICENSE file for details.