문서

API

마코노미의 공개 API를 소개합니다. 서버 상태, 플레이어 기록, 지리 정보를 직접 가져다 쓰실 수 있습니다.

이 문서의 목차 (5)

마코노미는 서버 데이터를 공개 API로 제공합니다.
디스코드 봇, 통계 사이트, 오버레이, 위젯 — 무엇을 만드셔도 좋습니다.

https://api.mcmi.kr/v1
참고

NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.

1분 만에 첫 요청#

키 없이 바로 되는 것부터 해보세요.

curl https://api.mcmi.kr/v1/status

{
  "data": {
    "online": true,
    "players": { "online": 0, "max": 2027 },
    "byServer": { "lobby": 0, "mainsv": 0 }
  }
}

나머지 엔드포인트는 ml_ 로 시작하는 키가 필요합니다. 발급 방법은 인증과 한도를 봐주세요.

엔드포인트#

서버 상태

로비와 메인 서버의 접속 인원을 한 번에 가져옵니다. 키가 필요 없습니다.

플레이어

플레이타임, 킬·데스, 접속 상태. 킬로그는 최대 90일치를 드립니다.

지리 정보

마크 좌표를 넣으면 현실에서 어디인지 알려드립니다.

유저 상점

유저 상점에 무엇이 등록되어 있는지 조회합니다. (현재 점검 중이라 503 을 돌려줍니다)

문서

지금 보고 계신 이 문서들을 마크다운 원문으로 가져갑니다.

오류와 한도

오류 형식, 상태 코드, 레이트리밋 헤더를 설명합니다.

한눈에 보기#

경로키내용
GET /v1/status불필요서버별 접속 인원
GET /v1/docs불필요문서 목록
GET /v1/docs/{경로}불필요문서 원문
GET /v1/economy/currencies불필요재화 목록
GET /v1/openapi.json불필요OpenAPI 3.1 스펙
GET /v1/players/{uuid|닉네임}필요플레이어 프로필
GET /v1/players/{id}/killlog필요킬·데스 로그 (최대 90일)
GET /v1/location/resolve필요좌표 → 현실 지리
GET /v1/shops/user/{id}필요유저 상점 등록 목록 (현재 점검 중)

약속드리는 것과 드리지 않는 것#

중요

공개하지 않는 정보#

아래 정보는 어떤 엔드포인트로도 나가지 않습니다.

  • 플레이어의 좌표와 월드 블록 정보
  • 채팅 원문
  • IP 주소, 권한 등급, 제재 이력
  • 개인 잔액과 후원 내역

좌표 공개는 그리핑과 스토킹의 도구가 됩니다. 킬로그에도 좌표를 담지 않습니다.

경고

/v1 은 하위 호환을 지킵니다. 필드를 추가할 수는 있어도 말없이 빼거나 뜻을 바꾸지 않습니다.
부득이하게 없앨 때는 응답에 Sunset 헤더로 먼저 알려드립니다.
그러니 모르는 필드가 늘어나도 깨지지 않게 파싱해 주세요.

쓰실 때 부탁드리는 것#

  • 캐시해 주세요. 응답에 Cache-Control 이 실립니다. 같은 값을 1초마다 다시 묻지 말아주세요.
  • 429 를 만나면 기다려 주세요. Retry-After 에 몇 초 뒤에 오시면 되는지 적혀 있습니다.
  • 키를 코드에 박지 말아주세요. 공개 저장소에 올라간 키는 폐기됩니다.
  • 만드신 것이 있다면 자랑해 주세요. 디스코드에서 기다리고 있습니다.

인증과 한도 · 오류

댓글

댓글은 마코노미 디스코드 서버 멤버만 쓸 수 있어요. 디스코드로 로그인