기록 조회
해당 API를 패턴별 통해 전일 정보를 조회할 수 있습니다.
일반 조회
GET /api/v2/record
위의 경로로 요청시 해당 패턴의 기록 목록을 확인할 수 있습니다.
요청에 사용되는 파라미터는 아래 표에서 확인할 수 있습니다.
| 키 | 타입 | 설명 | 비고 |
|---|---|---|---|
| button | string | 버튼 | 4B, 5B, 6B, 8B |
| lv | string | 난이도 | MX15, SC10, ..., SC15 |
| judge | string | 판정 | hard, max |
| song | string | 곡 고유 ID | UUIDv4 |
응답 형식은 데이터 형식에서 확인할 수 있습니다.
유저 기록 조회
GET /api/v2/record/user
위의 경로로 요청시 해당 유저의 해당 패턴의 기록을 확인할 수 있습니다.
요청에 사용되는 파라미터는 아래 표에서 확인할 수 있습니다.
| 키 | 타입 | 설명 | 비고 |
|---|---|---|---|
| button | string | 버튼 | 4B, 5B, 6B, 8B |
| lv | string | 난이도 | MX15, SC10, ..., SC15 |
| judge | string | 판정 | hard, max |
| song | string | 곡 고유 ID | UUIDv4 |
| uid | int | 유저 고유 ID값 | nickname과 같이 사용할 수 없습니다 |
| nickname | string | 닉네임 | uid와 같이 사용할 수 없습니다 |
유저의 닉네임과 고유 ID 값은 같이 지정해서 조회할 수 없습니다. 둘 중 하나의 값만 적용해야 합니다.
만약 둘 다 설정한 경우에는 uid 값을 우선해서 사용합니다.
닉네임으로 설정했다면 해당 닉네임으로 시작하는 유저를 검색 후 설정합니다.
응답 형식은 데이터 형식에서 확인할 수 있습니다.
데이터 형식
기록 데이터는 표에 지정된 형식을 JSON을 이용해 직렬화되어 제공됩니다.
표
아래 데이터가 배열에 담겨 제공됩니다.
| 키 | 형식 | 설명 |
|---|---|---|
| nickname | string | 해당 기록을 달성한 유저의 닉네임 |
| max_combo | bool | 맥스 콤보 달성 여부 |
| rate | float | 달성 판정 |
| score | int | 달성 점수 |
예시
[
{
"nickname": "name",
"max_combo": true,
"rate": 100.0,
"score": 350000
}
]
불러오기 개수 제한
추가적인 설정이 없다면 1개의 기록을 가져옵니다.
다만, 추가적인 설정을 통해 최대 30개까지 불러올 수 있습니다.
limit파라미터를 이용해 설정할 수 있습니다. (ex.?limit=<개수>)