Skip to content

Commit 4357ed5

Browse files
committed
Update 5.1.5
1 parent 824cf6f commit 4357ed5

File tree

2 files changed

+96
-6
lines changed

2 files changed

+96
-6
lines changed

assets/scripts/responses.js

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ const endpoints = {
7979
type: 'Date',
8080
description: 'Date of user\'s last ranked match'
8181
},
82+
{
83+
name: 'timestamp.nextDecay',
84+
type: 'Date?',
85+
description: 'Date of user\'s next decay time'
86+
},
8287
{
8388
name: 'statistics.season.[key].[ranked | casual]',
8489
type: 'Integer?',
@@ -425,6 +430,81 @@ const endpoints = {
425430
],
426431
sampleUrl: `https://api.mcsrranked.com/users/3c8757790ab0400b8b9e3936e0dd535b/seasons`
427432
},
433+
'users/{identifier}/live': {
434+
title: `Get User's Live Match Data`,
435+
method: 'GET',
436+
category: 'users',
437+
description: 'Returns real-time match data from the Private Room the player is in. To access this data, a `Private-Key` header is required. And, the player must be host or co-host of the Private Room.',
438+
params: [
439+
{
440+
name: '{identifier}',
441+
type: 'UserIdentifier',
442+
required: true,
443+
description: 'Check the `Objects#UserIdentifier` section.'
444+
},
445+
{
446+
name: 'Private-Key',
447+
type: 'String [Header]',
448+
required: true,
449+
description: 'It can be generated in-game via Profile -> Settings -> Generate & Copy API Private Key.'
450+
}
451+
],
452+
structures: [
453+
{
454+
name: 'lastId',
455+
type: 'Integer?',
456+
description: 'Match ID of previous match. All data will be reset when the match has ended. You can get previous match data with this.'
457+
},
458+
{
459+
name: 'type',
460+
type: 'MatchType'
461+
},
462+
{
463+
name: 'status',
464+
type: 'String',
465+
description: 'It will be one of these value: `idle`, `counting`, `generate`, `ready`, `running`, `done`'
466+
},
467+
{
468+
name: 'time',
469+
type: 'Time',
470+
description: 'It will be `0` if match has not started.'
471+
},
472+
{
473+
name: 'players',
474+
type: 'UserProfile[]',
475+
},
476+
{
477+
name: 'spectators',
478+
type: 'UserProfile[]',
479+
},
480+
{
481+
name: 'timelines[].uuid',
482+
type: 'String',
483+
description: 'Player uuid of timeline'
484+
},
485+
{
486+
name: 'timelines[].time',
487+
type: 'Time',
488+
description: 'Match time of timeline'
489+
},
490+
{
491+
name: 'timelines[].type',
492+
type: 'String',
493+
description: 'Identifier of timeline'
494+
},
495+
{
496+
name: 'completions[].uuid',
497+
type: 'String',
498+
description: 'Player uuid of completion'
499+
},
500+
{
501+
name: 'completions[].time',
502+
type: 'Time',
503+
description: 'Match time of completion'
504+
},
505+
],
506+
sampleUrl: `https://api.mcsrranked.com/users/3c8757790ab0400b8b9e3936e0dd535b/seasons`
507+
},
428508
'matches/': {
429509
title: `Get Recent Matches`,
430510
method: 'GET',

index.html

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,16 @@ <h2 class="page-title"><strong><span class="label label-success">Class</span> &n
300300
<td><code>Integer</code></td>
301301
<td>Level of achievement</td>
302302
</tr>
303+
<tr>
304+
<td>value</td>
305+
<td><code>Integer?</code></td>
306+
<td>Contains current player's progression of achievement. If achievement is not leveling one, it will be <code>null</code></td>
307+
</tr>
308+
<tr>
309+
<td>goal</td>
310+
<td><code>Integer?</code></td>
311+
<td>Next level goal of achievement. If achievement is max level or not leveling one, it will be <code>null</code></td>
312+
</tr>
303313
</tbody>
304314
</table>
305315
</div>
@@ -339,7 +349,7 @@ <h2 class="page-title"><strong><span class="label label-success">Class</span> &n
339349
</tr>
340350
<tr>
341351
<td>category</td>
342-
<td><code>String</code></td>
352+
<td><code>String?</code></td>
343353
<td>Match completions category. Default is <code>ANY</code></td>
344354
</tr>
345355
<tr>
@@ -437,11 +447,6 @@ <h2 class="page-title"><strong><span class="label label-success">Class</span> &n
437447
<td><code>String</code></td>
438448
<td>(Advanced) Player uuid of completion</td>
439449
</tr>
440-
<tr>
441-
<td>replayExist</td>
442-
<td><code>Boolean</code></td>
443-
<td>(Advanced) Whether match replay is exist in the server</td>
444-
</tr>
445450
<tr>
446451
<td>completions[].time</td>
447452
<td><code>Time</code></td>
@@ -462,6 +467,11 @@ <h2 class="page-title"><strong><span class="label label-success">Class</span> &n
462467
<td><code>String</code></td>
463468
<td>(Advanced) Identifier of timeline</td>
464469
</tr>
470+
<tr>
471+
<td>replayExist</td>
472+
<td><code>Boolean</code></td>
473+
<td>(Advanced) Whether match replay is exist in the server</td>
474+
</tr>
465475
</tbody>
466476
</table>
467477
</div>

0 commit comments

Comments
 (0)