MapleStory.OpenAPI 3.1.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package MapleStory.OpenAPI --version 3.1.0
                    


                    

                
NuGet\Install-Package MapleStory.OpenAPI -Version 3.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="MapleStory.OpenAPI" Version="3.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="MapleStory.OpenAPI" Version="3.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="MapleStory.OpenAPI" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add MapleStory.OpenAPI --version 3.1.0
                    


                    

                
#r "nuget: MapleStory.OpenAPI, 3.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=MapleStory.OpenAPI&version=3.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=MapleStory.OpenAPI&version=3.1.0
                    


                            Install as a Cake Tool

MapleStory OpenAPI C# Library

NuGet C#

넥슨의 MapleStory OpenAPI를 C# 환경에서 사용할 수 있게 해주는 라이브러리입니다.

다른 언어로 작성된 패키지는 여기에서 확인할 수 있습니다.

(English document is HERE)

Notice

🌏 알림1: 3.0.0 버전부터 여러 서비스 지역에 대한 지원이 추가 되었습니다. 현재 KMS, MSEA의 데이터를 조회 가능합니다.

💡 알림2: Version 2.x.x → 3.0.0 업데이트 과정에서 마이그레이션이 필요합니다. Migration 항목을 참고 해주세요.

Installation

NuGet 기반 프로젝트에 아래 정보를 입력하여 패키지를 추가하세요:

dotnet add package MapleStory.OpenAPI

Usage

API Key

라이브러리를 사용하기 전에 Nexon Open API 콘솔에서 애플리케이션을 등록하고 api key를 발급 받으세요.

애플리케이션은 지역별로 따로 등록해야 합니다. (KMS의 api key로 MSEA의 데이터를 요청할 수 없음)

Region

현재 KMS, MSEA 지역에 대한 데이터 조회를 지원 합니다. 조회를 원하는 지역별로 네임스페이스를 다르게 설정 합니다.

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

지역이 달라도 동일한 인터페이스를 상속하기 때문에 API의 사용 경험은 기본적으로 동일 합니다.

Sample Code

아래 코드는 KMS 서버에서 닉네임을 바탕으로 특정 캐릭터의 식별자를 조회한 후 캐릭터의 기본 정보를 조회하는 예시입니다.

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
}

더 많은 예시는 아래 링크의 테스트 케이스에서 확인할 수 있습니다.

Exception Handling

MapleStory OpenAPI 가이드에 서술된 에러 사유를 MapleStoryAPIException를 통해 예외 처리 해야합니다.

MapleStoryAPI는 특정 상태의 예외를 발생시키지 않도록 설계되었으나, 라이브러리를 사용하는 개발자의 실수로 인해 여전히 일부 상태의 예외가 발생할 수 있습니다.

따라서 아래 표에 설명된 MapleStoryAPIErrorCode 목록을 기반으로 MapleStoryAPIException를 예외 처리하시기 바랍니다.

ErrorCode Description
OPENAPI00001 서버 내부 오류
OPENAPI00002 권한이 없는 경우
OPENAPI00003 유효하지 않은 식별자
OPENAPI00004 파라미터 누락 또는 유효하지 않음
OPENAPI00005 유효하지 않은 API KEY
OPENAPI00006 유효하지 않은 API PATH
OPENAPI00007 API 호출량 초과
OPENAPI00009 데이터 준비 중
OPENAPI00010 게임 점검 중
OPENAPI00011 API 점검 중
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.1.0 134 6/19/2025
3.0.0 292 6/12/2025
2.13.1 210 5/12/2025
2.13.0 163 3/29/2025
2.12.1 158 3/20/2025
2.12.0 161 3/20/2025
2.11.0 128 2/21/2025
2.10.0 109 1/17/2025
2.9.0 112 12/19/2024
2.8.0 119 11/24/2024
2.7.2 133 10/3/2024
2.7.1 153 8/14/2024
2.7.0 140 7/19/2024
2.6.1 121 7/8/2024
2.6.0 134 6/14/2024
2.5.0 174 4/9/2024
2.4.1 159 2/21/2024
2.4.0 153 1/26/2024
2.3.2 187 1/9/2024
2.3.1 156 1/4/2024
2.3.0 140 12/31/2023
2.2.0 150 12/27/2023
2.1.1 165 12/24/2023
2.1.0 143 12/23/2023
2.0.0 153 12/14/2023
1.1.0 161 12/3/2023
1.0.1 141 11/28/2023
1.0.0 151 11/18/2023