MapleStory.OpenAPI 3.4.1

MapleStory OpenAPI C# Library

This C# library enables the use of the MapleStory OpenAPI of Nexon.

Packages written in other languages can be found HERE.

English | 한국어

Notice

🌏 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 3: Migration is required when updating from version 2.x.x to 3.0.0. Please refer to the documentation for Migration.

Installation

Install the latest version of the C# library in your NuGet project:

dotnet add package MapleStory.OpenAPI

Usage

API Key

Before using the library, register your application and obtain an api key from the Nexon Open API Console.

Applications must be registered separately for each region. (For example, an API key issued for KMS cannot be used to request data from MSEA.)

Region

Currently, this library supports data retrieval from the KMS, TMS, MSEA regions. To access data from a specific region, import the corresponding namespace.

using MapleStory.OpenAPI.KMS; // data from KMS
// or
using MapleStory.OpenAPI.MSEA; // data from MSEA

Even though the regions differ, each package inherits the same interface, ensuring a consistent API usage experience across all regions.

Sample Code

Below is an example that retrieves the identifier of a specific character from the KMS server based on the nickname, and then fetches that character’s basic information.

using MapleStory.OpenAPI.KMS;

var apiKey = "{Your API Key}";
var api = new MapleStoryAPI(apiKey);

// run your code
try
{
    var character = await api.GetCharacter("{Your Character Name}");
    var characterBasic = await api.GetCharacterBasic(character.OCID);

    Console.WriteLine(characterBasic.ToJson());
}
// exception handling
catch (MapleStoryAPIException e)
{
    // handle MapleStoryApiException
}
catch (HttpRequestException e)
{
    // handle HttpRequestException
}

You can find more examples in the test cases at the following link.

• Character Information Retrieval
• Union Information Retrieval
• Guild Information Retrieval
• History Information Retrieval
• Ranking Information Retrieval
• Notice Information Retrieval

Features

This library supports all apis published in the MapleStory OpenAPI official docs.

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

Exception Handling

Handle MapleStoryAPIException to safely make calls, ensuring that specific Status defined in the MapleStory OpenAPI Guide are not encountered.

While MapleStoryAPI is designed to prevent the occurrence of certain Status, exceptions may arise due to developer mistakes.

Therefore, it's recommended to use MapleStoryAPIException for exception handling based on the MapleStoryAPIErrorCode list described in the table below.