---
url: https://wiki.awmc.team/en/dev.md
---

# Developer Center

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

::: danger ⚠️ 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](https://mai.chongxi.us/) (no affiliation with AWMC).
:::

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

* **Authentication**:  (Public access for all users)
* **Rate Limit**: `10 QPS` (Queries Per Second)
* **Documentation**: [View Status API Details](/en/dev/status-api)

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

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

* **Authentication**:  (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](/en/dev/awmc-api)

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

::: info 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**: 
* **Main Endpoints**: `POST /api/bot/sync`, `GET /api/bot/player/{qq}`
* **Documentation**: [View AWMCNET Bot API Details](/en/dev/awmcnet-api)

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

::: info 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**:  (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](/en/dev/assets-api)

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

::: info 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**:  (Public access)
* **Documentation**: [View Chart Preview Details](/en/dev/chart-preview)

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

::: info 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**:  (Must be included in Authorization header)
* **Documentation**: [View Chart Review & Analysis API Details](/en/dev/chart-preview-api)

## Quick Start

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

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

::: tip Suggestion
If you encounter any issues during development, feel free to submit an Issue on [GitHub](https://github.com/Michaelwucoc/awmc-wiki) or contact our team.

You are also welcome to join the developer QQ group: [1067350296](https://qm.qq.com/q/TJUgWpUAcS).
:::