Skip to content

Online Api

Jump to bottom Edit New page
LeZi edited this page Mar 25, 2026 · 1 revision

Account API

Register

Create a new user account.

Endpoint

POST /api/account/Register

Content-Type

multipart/form-data

Parameters

Name Type Description
username string Username
password string Password
email string Email address
cf-turnstile-response string Cloudflare Turnstile verification token

Login

Authenticate a user.

Endpoint

POST /api/account/Login

Content-Type

multipart/form-data

Parameters

Name Type Default Description
username string Username
password string Password
rememberMe boolean false Keep session logged in

Logout

Endpoint

POST /api/account/logout

Query Parameters

Name Type
sessionId string

Get Current User Info

GET /api/account/info

Returns information about the currently authenticated user.

Get Current Session

GET /api/account/session

Get All Sessions

GET /api/account/sessions

User Introduction

Get User Introduction

GET /api/account/intro
Parameter Type Default
username string ""

Update User Introduction

POST /api/account/intro

Content-Type

multipart/form-data
Parameter Type
content string

Get User Icon

GET /api/account/icon
Parameter Type
username string

Get Recent Activity

GET /api/account/Recent
Parameter Type
username string

Verify OTP

GET /api/account/verify
Parameter Type
otp string

Forgot Password

Request Reset

POST /api/account/forget

Content-Type

multipart/form-data
Parameter Type
username string
email string

Reset Password

PUT /api/account/forget

Content-Type

multipart/form-data
Parameter Type
otp string
newpassword string

Collection API

List Collections

GET /api/collection/list
Parameter Type Default
page integer 0
pageSize integer 30

Create Collection

POST /api/collection/create

Content-Type

application/json

Request Body

{
  "name": "string",
  "description": "string",
  "visibility": 0
}

Visibility

Value Meaning
0 Private
1 Public

Get Collection Hash List

GET /api/collection/{idStr}/hashlist

Get Collection Song List

GET /api/collection/{idStr}/songlist

Delete Collection

POST /api/collection/{idStr}/destroy

Modify Collection

POST /api/collection/{idStr}/modify

Request Body

{
  "name": "string",
  "description": "string",
  "visibility": 0,
  "items": [
    "hash1",
    "hash2"
  ]
}

MaiChart API

List Charts

GET /api/maichart/list
Parameter Type
sort string
search string
page integer
isRanking boolean

Get Chart Metadata

GET /api/maichart/{chartId}/summary

Get Chart File

GET /api/maichart/{chartId}/chart

Get Chart Audio

GET /api/maichart/{chartId}/track

Get Chart Image

GET /api/maichart/{chartId}/image
Parameter Type Default
fullImage boolean false

Get Chart Video

GET /api/maichart/{chartId}/video

Score API

Get Chart Scores

GET /api/maichart/{chartId}/score

Submit Score

POST /api/maichart/{chartId}/score

Request Body

{
  "chartLevel": 0,
  "hash": "string",
  "dxScore": 0,
  "comboState": 0,
  "acc": {
    "dx": 0,
    "classic": 0
  }
}

Interaction API

Get Interactions

GET /api/maichart/{chartId}/interact

Create Interaction

POST /api/maichart/{chartId}/interact

Content-Type

multipart/form-data
Parameter Type
type string
content string
replyTo string

Delete Interaction

DELETE /api/maichart/{chartId}/interact
Parameter Type
type string
commentId string

Machine API

Register Machine

POST /api/machine/register

{
  "name": "string",
  "description": "string"
}

Get Machine Info

GET /api/machine/Info
Parameter Type
machine-id string

Persist API

Get Application Data

GET /api/persist/app/{appId}/{category}

Update Application Settings

POST /api/persist/app/1096/settings

Upload API

Upload Chart

POST /api/maichart/upload

Content-Type

multipart/form-data
Parameter Type
formfiles file[]

Delete Chart

POST /api/maichart/delete
Parameter Type
chartId string

Statistics API

Score Statistics

GET /api/stats/score-sums
Parameter Type
uploader string
page integer
pageSize integer

Utility API

Ping

Check if the API service is alive.

GET /api/utils/Ping

　　　　　　　　　   .　-‐. : . : . : . : . ：. : . : .
　　　　　  　　 ／: . : . : . : . : . : . : . : . : . : ＼....
　　　　　   ／: . : . : . : . : . : . : . : . : . : . : . ＼ ::.;
　　　　／}ﾚ': : . : . : . : . : . : . : . : . : .＼: . ヽ: . : . :.ヽ
　　　 /: :/: . : . : . : . :l: :八: . : . : : ＼: : : :+———+ : '.:.:ｌ:
　　 /: :/: . : . :+———+: . :/l: :|\＼: :＼: : : ＼::.: | X.|::.:l:.::...:|:
　　/: ://: : . : .| X.|: / .j: :| | \＼: ヽ＼:ヽ＼: :..+———+:.:|::|::|: .
　 //://|: : :ｌ: :+———+. i斗'^　　　　 　 　,ｨf弌ぅ ､  |:.:.l::|::|:.:|＼|  __    __     ______       __     ______   __         ______     __  __   
／/:ノ /|: :/}: : : |: l   ,ｨfﾟう　　　　　   ﾄ::)ﾟｨﾘ ヽ |:.:|:/:::|:.:|    /\ "-./  \   /\  __ \     /\ \   /\  == \ /\ \       /\  __ \   /\ \_\ \   
　 }: : /|:|:/: |: :∧:i  /ん:::ﾊ　　　　 　   弋c少'　 |:.:|:.::.|:.:|     \ \ \-./\ \  \ \  __ \   _\_\ \  \ \  _-/ \ \ \____  \ \  __ \  \ \____ \  
　 |: / .|:|': : |: :/: :i   弋cソ　 　 　 　   ､､､､､.  |:.:八:.:八:.|       \ \_\ \ \_\  \ \_\ \_\ /\_____\  \ \_\    \ \_____\  \ \_\ \_\  \/\_____\ 
   |/　 l: : : :|V: : ﾊ　 ､､､､　　     ′　　 　 　      ｌ:∧: ./ 　ヽ        \/_/  \/_/   \/_/\/_/ \/_____/   \/_/     \/_____/   \/_/\/_/   \/_____/ 
　　   八: :.∧: |: :人　 　r ､_　       ､　  　      ｨﾉ:/:/\:./
　　　　　∨　V}: : |: /i＞}/ ,へ、　　            イj:V／:/　V
 　 　 　 　 　 八: :|/  ＿_ !　　/ ﾊ　＿    斗‐{
　　 　 　 　 　 ∧!　   ＿|　 　 ' /´　 　 　》────────--､
 　　　　　　　　_/　  |:::_}　　　.|ー─--＜　　 　        |
 　　　　　　／___　 i　}∧　　　ﾉ::::::::::::/ ／ 　     |
　　　　　　 V　　　 ／　}. 　ｲ l＼::::::::::/ /　　 　　:|
　　　　　　rﾍ 　 xﾍ　 　  ∨　| |:|　＼／_/　　　        人
　　　　　   /＿／ 　 '、　　_ヽ | |:|　　   ./　 　- ─  - 〉
　　　　    /　　 　 　　 ヽ   ／/／ j/　　〈 ／　-‐    ／
Add a custom sidebar

Clone this wiki locally