API songs

/songs

/

GET

To get some songs' information.

• power required: 'select', 'select_song_info'
• query:

  Key	Allowed values
  query	'song_id', 'name'
  fuzzy_query	'song_id', 'name'
  sort	'song_id', 'name', 'rating_pst', 'rating_prs', 'rating_ftr', 'rating_byn'

• response data: list[dict]

POST

To add the information of a new song.

• power required: 'change'
• request data: dict

  Key	Type	Optional
  song_id	str
  charts	list[dict]
  name	str	Y

  • charts
    • difficulty: int
    • chart_const: float Up to one decimal place, negative number for the unranked chart
    • e.g. [{'difficulty': 0, 'chart_const': 9.9}, ...]
• response data: dict

/<song_id>

GET

To get a song's information.

• power required: 'select', 'select_song_info'
• response data: dict

PUT

To change a song's information.

• power required: 'change'

• request data: dict

  Key	Type	Optional
  name	str	Y
  charts	list[dict]	Y

  • charts

• response data: dict

DELETE

To delete a songs' information.

• power required: 'change'

/<song_id>/<difficulty>/rank

GET

To get a chart's ranklist, just like the ranklist in the game.

• power required: 'select', 'select_song_rank', 'select_song_rank_top'
  • The user with only 'select_song_rank_top' power can only get top 20 scores.
• query / request data: dict

  Key	Type	Optional
  limit	int	Y

• response data: list[dict]