Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hud0shnik/osustatsapi
Апи для получения статистики из OSU 🎶
https://github.com/hud0shnik/osustatsapi
api go osu
Last synced: 1 day ago
JSON representation
Апи для получения статистики из OSU 🎶
- Host: GitHub
- URL: https://github.com/hud0shnik/osustatsapi
- Owner: hud0shnik
- License: bsd-3-clause
- Created: 2022-05-17T13:32:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T10:13:15.000Z (2 months ago)
- Last Synced: 2024-09-20T04:16:10.270Z (about 2 months ago)
- Topics: api, go, osu
- Language: Go
- Homepage: https://osustatsapi.vercel.app
- Size: 616 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🖌️ OsuStatsApi 🎶
## Overview
- [Overview](#overview)
- [User](#user)
- [Online](#online)
- [Map](#map)
## User
### Request
``` Elixir
https://osustatsapi.vercel.app/api/user
```
Parameter | Value type | Required | Description
----------------|------------|----------|------------
id | string | Yes |username
type | string | No |response type (like "string")
### Structures
#### userInfo
Field | Type | Description
----------------------------|--------------------|------------
avatar_url | string |
country_code | string | like "RU" or "JP"
default_group | string |
id | int |
is_active | bool |
is_bot | bool |
is_deleted | bool |
is_online | bool |
is_supporter | bool |
last_visit | string |
pm_friends_only | bool | PM allowed only for
profile_color | string |
username | string |
cover_url | string |
discord | string |
has_supported | bool |
interests | string |
join_date | string | like "2022-05-01T19:27:43+00:00"
kudosu | int |
location | string |
max_friends | int |
max_block | int |
occupation | string |
playmode | string |
playstyle | []string |
post_count | int |
profile_order | []string |
title | string |
title_url | string |
twitter | string |
website | string |
country_name | string | like "Japan"
cover | [cover](#cover) |
is_admin | bool |
is_bng | bool | Beatmap Nominators Group
is_full_bn | bool | full ban
is_gmt | bool | Global Moderation Team
is_limited_bn | bool | limited ban
is_moderator | bool |
is_nat | bool | Nomination Assessment Team
is_restricted | bool | timeout from the community
is_silenced | bool |
account_history | string |
active_tournament_banner | string |
badges | [[]badges](#badges)|
comments_count | int |
follower_count | int |
groups | string | like "Developers"
mapping_follower_count | int |
pending_beatmapset_count | int |
previous_usernames | []string |
level | int |
global_rank | int |
pp | float | float value, 4 decimals
ranked_score | int |
accuracy | float | like "97.132"
play_count | int |
play_time | string | like "202h24m22s"
play_time_seconds | int |
total_score | int |
total_hits | int |
maximum_combo | int |
replays | int | replays watched by others
is_ranked | bool |
ss | int |
ssh | int | silver ss
s | int |
sh | int | silver s
a | int |
country_rank | int |
support_level | int |
achievements |[[]achievement](#achievement)|
medals | int |
rank_history |[history](#history) |
unranked_beatmapset_count | int |
#### cover
Field | Type | Description
----------------------------|--------------------|------------
custom_url | string |
url | string |
id | int |
#### badge
Field | Type | Description
----------------------------|--------------------|------------
awarded_at | string | like "2022-10-08T03:47:35+00:00"
description | string |
image_url | string |
#### achievement
Field | Type | Description
----------------------------|--------------------|------------
achieved_at | string | UTC format date (yyyy-mm-ddThh:ss:ssZ)
achievement_id | string |
#### history
Field | Type | Description
----------------------------|--------------------|------------
mode | string | like "osu"
data | []int |
## Online
### Request
``` Elixir
https://osustatsapi.vercel.app/api/online
```
Parameter | Value type | Required | Description
----------------|------------|----------|------------
id | string | Yes | username
type | string | No | response type (like "string")
### Structures
#### onlineResponse
Field | Type | Description
----------------------------|--------------------|------------
status | bool | true = online
## Map
### Request
``` Elixir
https://osustatsapi.vercel.app/api/map
```
Parameter | Value type | Required | Description
----------------|------------|----------|-------------
id | int | Yes | map id
type | string | No | response type (like "string")
### Structures
#### mapResponse
Field | Type | Description
----------------------------|--------------------|------------
artist | string |
artist_string | string |
covers | [covers](#covers) |
creator | string |
favorite_count | int |
hype_current | int |
hype_required | int |
id | int |
nsfw | bool |
offset | int |
play_count | int |
preview_url | string | track preview (like "b.ppy.sh/preview/26154.mp3")
source | string |
spotlight | bool | spotlight map (a recurring curation program for recommending and highlighting beatmaps)
status | string |
title | string |
title_unicode | string |
track_id | int |
user_id | int |
video | bool |
download_disabled | bool |
bpm | float |
can_be_hyped | bool |
discussion_enabled | bool |
discussion_locked | bool |
is_scoreable | bool |
last_updated | string |
legacy_thread_url | string |
nominations_summary |[nominationsSummary](#nominationsSummary)|
ranked | int |
ranked_date | string |
storyboard | bool |
submitted_date | string |
tags | []string |
beatmaps | [[]maps](#maps) |
converts | [[]maps](#maps) |
current_nominations |[[]currentNomination](#currentNomination)|
description | string |
genre_id | int |
genre_name | string |
language_id | int |
language_name | string |
ratings | []int |
recent_favourites | [[]bmUser](#bmUser)|
related_users | [[]bmUser](#bmUser)|
user | [bmUser](#bmUser) |
comments |[[]comment](#comment)|
pinned_comments |[[]comment](#comment)|
user_follow | bool |
#### covers
Field | Type | Description
----------------------------|--------------------|------------
cover | string |
cover@2x | string |
card | string |
card@2x | string |
list | string |
list@2x | string |
slimcover | string |
slimcover@2x | string |
#### nominationsSummary
Field | Type | Description
----------------------------|--------------------|------------
current | int |
required | int |
#### maps
Field | Type | Description
----------------------------|--------------------|------------
beatmapset_id | int |
difficulty_rating | float |
id | int |
mode | string |
status | string |
total_length | int |
user_id | int |
version | string |
accuracy | float |
ar | float | approach rate (a beatmap difficulty setting that defines when hit objects start to fade in relative to when they should be hit or collected)
bpm | float | beat per minute
convert | bool |
count_circles | int |
count_sliders | int |
count_spinners | int |
cs | float | circle size
deleted_at | string |
drain | float | drain time refers to the total duration of a beatmap that requires the player to be active
hit_length | int |
is_scoreable | bool |
last_updated | string |
mode_int | int |
pass_count | int |
play_count | int |
ranked | int |
url | string |
checksum | string |
failtimes |[failtimes](#failtimes)|
max_combo | int |
#### failtimes
Field | Type | Description
----------------------------|--------------------|------------
Fail | []int |
Exit | []int |
#### currentNomination
Field | Type | Description
----------------------------|--------------------|------------
beatmapset_id | int |
rulesets | string |
reset | bool |
user_id | int |
#### bmUser
Field | Type | Description
----------------------------|--------------------|------------
avatar_url | string |
country_code | string |
default_group | string |
id | int |
is_active | bool |
is_bot | bool |
is_deleted | bool |
is_online | bool |
is_supporter | bool |
last_visit | string |
pm_friends_only | bool |
profile_color | string |
username | string |
#### comment
Field | Type | Description
----------------------------|--------------------|------------
id | int |
parent_id | int |
user_id | int |
pinned | bool |
replies_count | int |
votes_count | int |
commentable_type | string |
commentable_id | int |
legacy_name | string |
created_at | string |
updated_at | string |
deleted_at | string |
edited_at | string |
edited_by_id | string |
message | string |
message_html | string |
[](/LICENSE)