Developer Center

Welcome to the AWMC Developer Center. We provide developers with various APIs and tools to help you build your own maimai applications or integration services.

Status API Deprecated (Former base URL: https://status.awmc.cc)

⚠️ This API is deprecated

AWMC has discontinued the Status API. It is no longer maintained — please do not integrate it. For maimai server status data, see the community project mai.chongxi.us (no affiliation with AWMC).

Service Overview

Real-time monitoring of the operational status of maimai services provided by AWMC (historical archive).

• Authentication: No Auth Required (Public access for all users)
• Rate Limit: 10 QPS (Queries Per Second)
• Documentation: View Status API Details

AWMC Public API (Base URL: https://api.wmc.pub)

Business API

User data / chart queries, charge enqueue & queue, and score upload (DivingFish / Lxns) via the new /v1/user/* and /v1/charge routes.

• Authentication: Bearer Token (Must be included in Authorization header)
• Token Consumption: Charged on HTTP success and upstream business success (returnCode===1, or 0 for health/ping). Public paths stay mostly compatible with legacy /v1/*.
• Documentation: View AWMC Public API Details

AWMCNET Bot API (Base URL: https://net.wmc.pub)

Score Mirror & Queries

Score sync interfaces for QueryBot and score checkers, supporting full-snapshot submission in chunks with a shared snapshot_id to avoid timeouts from large score packages in one request.

• Authentication: Bot-Token
• Main Endpoints: POST /api/bot/sync, GET /api/bot/player/{qq}
• Documentation: View AWMCNET Bot API Details

Assets Static Resource API (Base URL: https://download.wmc.pub)

Static Resources

Use download.wmc.pub for cover images, the chart index, single-chart files and packages. The old asset domains and /covers/:id are no longer integration endpoints.

• Authentication: No Auth Required (Public access)
• Resource types: Cover images (check Content-Type), chart text, audio, PV and single-chart packages; bulk packages still require human verification.
• Documentation: View Assets Static Resource API Details

Chart Preview (Entry: https://v.awmc.cc)

Browser Preview

Preview maimai charts in the browser. Parameters correspond to Lxns song IDs, chart types, and difficulty levels, suitable for development and sharing links.

• Authentication: No Auth Required (Public access)
• Documentation: View Chart Preview Details

Chart Review & Analysis API (Base URL: https://v.wmc.pub/api/v1/)

REST API

Public REST API for the Chart Preview platform, supporting chart queries, comments, ratings, score submissions, rankings, and more. Requires API Key authentication.

• Authentication: Bearer API Key (Must be included in Authorization header)
• Documentation: View Chart Review & Analysis API Details

Quick Start

You can quickly access different module documentation via the following links:

• Status API - (Deprecated) Formerly provided real-time service status, heartbeat records, and announcements.
• AWMC Public API - User queries, charge queue, score upload (DivingFish / Lxns).
• AWMCNET Bot API - Score mirroring, player queries, and chunked snapshot sync.
• Assets Static Resource API - Jacket art, resource gallery, and other static file retrieval.
• Chart Preview - In-browser chart preview and query parameter documentation.
• Chart Review & Analysis API - REST API for chart queries, comments, ratings, score submissions, and rankings.
• [More Features] - Under development, stay tuned...

Suggestion

If you encounter any issues during development, feel free to submit an Issue on GitHub or contact our team.

You are also welcome to join the developer QQ group: 1067350296.