Skip to content

Commit 8a0913a

Browse files
mdashlwmdashlw
authored
Update all response examples (#252)
* Update all examples * More examples * Remove ... * Update key example * Update guild example * More explanation of recentGames and key
1 parent a975f27 commit 8a0913a

File tree

17 files changed

+371
-478
lines changed

17 files changed

+371
-478
lines changed

‎Documentation/methods/boosters.md‎

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,36 @@ Returns list of boosters.
88
- key
99

1010
## Example Response
11-
```php
11+
```js
1212
{
13-
"success": true,
14-
"boosters": [
15-
{
16-
"purchaserUuid": "",
17-
"amount": 3, // multiplier
18-
"originalLength": 3600,
19-
"length": 2329, // length remaining
20-
"gameType": 20, // GameType ID
21-
"dateActivated": 1471657389139 // unix timestamp
22-
"stacked": [
23-
"" // array of up to 10 UUIDs who have stacked the booster, or "true" if there are none
24-
]
25-
}
26-
]
27-
"boosterState": {
28-
"decrementing": true // indicates whether booster duration is ticking down
29-
}
13+
"success": true,
14+
"boosters": [
15+
{
16+
"_id": "5c197fadc8f245280926413d",
17+
"purchaserUuid": "978ddb705a8e43618e41749178c020b0",
18+
"amount": 2, // Multiplier
19+
"originalLength": 3600,
20+
"length": 3595, // Length remaining
21+
"gameType": 24, // GameType ID
22+
"dateActivated": 1545244519133,
23+
"stacked": true
24+
},
25+
{
26+
"_id": "5de1bf590cf2544cd01a7e04",
27+
"purchaserUuid": "9e29fa1bedde445abb79526e22a7e051",
28+
"amount": 2.2,
29+
"originalLength": 3600,
30+
"length": 2074,
31+
"gameType": 13,
32+
"dateActivated": 1590842991659,
33+
"stacked": [ // Array of up to 10 UUIDs who have stacked the booster
34+
"e8558c2a-935c-4eba-9a20-1e7eddeb2530",
35+
"d33dbdc9-a65b-4090-ab20-d101452647fa"
36+
]
37+
}
38+
],
39+
"boosterState": {
40+
"decrementing": true // Indicates whether booster duration is ticking down
41+
}
3042
}
3143
```

‎Documentation/methods/findGuild.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,13 @@ Returns the id of the requested guild.
55

66
## Parameters
77
- key
8-
- byName _(Case sensitive, HTML encode spaces)_
8+
- byName
99
- byUuid
10+
11+
## Example Response
12+
```js
13+
{
14+
"success": true,
15+
"guild": "553490650cf26f12ae5bac8f"
16+
}
17+
```

‎Documentation/methods/friends.md‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# friends
1+
# friends
22

33
## Description
44
Returns friendships for given player.
@@ -8,13 +8,16 @@ Returns friendships for given player.
88
- uuid
99

1010
## Example Response
11-
```php
12-
[
11+
```js
12+
{
13+
"success": true,
14+
"records": [
1315
{
14-
"uuidSender": "",
15-
"uuidReceiver": "",
16-
"started": 1376865614794 // unix timestamp
17-
},
18-
...
19-
]
20-
```
16+
"_id": "5eb97d170cf22f431e8d6170",
17+
"uuidSender": "20934ef9488c465180a78f861586b4cf",
18+
"uuidReceiver": "7486aa03aca5470e888dde8a43eb8c10",
19+
"started": 1589214487454
20+
}
21+
]
22+
}
23+
```

‎Documentation/methods/gameCounts.md‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
11
# gameCounts
22

33
## Description
4-
Returns the current player count along with the player count of each public game + mode on the server.
4+
Returns the current player count along with the player count of each public game + mode on the server.
55

66
Due to the large amount of modes and that they can change at anytime we don't currently have a friendly list of mode keys to clean names. This may be added at a later date.
7-
7+
88
## Parameters
99
- key
1010

11-
## Example Player Count
12-
```php
11+
## Example Response
12+
```js
1313
{
14-
"games": {
15-
"BUILD_BATTLE": { // The GameType Name
16-
"modes": {
17-
"BUILD_BATTLE_HALLOWEEN": 82, // The mode key along with the player count
18-
"BUILD_BATTLE_GUESS_THE_BUILD": 177,
19-
"BUILD_BATTLE_TEAMS_NORMAL": 512,
20-
"BUILD_BATTLE_SOLO_NORMAL": 440,
21-
"BUILD_BATTLE_SOLO_PRO": 114
22-
},
23-
"players": 1453 // Total players for the GameType
24-
}
25-
},
26-
"playerCount": 59715
14+
"success": true,
15+
"games": {
16+
"SKYBLOCK": { // The GameType Name
17+
"players": 30522, // Total players for the GameType
18+
"modes": {
19+
"combat_1": 690, // The mode key along with the player count
20+
"foraging_1": 1456,
21+
"hub": 8049,
22+
"mining_2": 1062,
23+
"combat_2": 277,
24+
"farming_2": 247,
25+
"mining_1": 300,
26+
"farming_1": 204,
27+
"combat_3": 2350,
28+
"dynamic": 15888
29+
}
30+
}
31+
},
32+
"playerCount": 77238 // Total players on the network
2733
}
2834
```

‎Documentation/methods/guild.md‎

Lines changed: 69 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -11,95 +11,75 @@ See [`resources.md`](/Documentation/methods/resources.md) for a JSON list of Gui
1111
- player (Lookup by Player UUID)
1212
- name (Lookup by Guild name)
1313

14-
## Example
15-
```php
14+
## Example Response
15+
```js
1616
{
17-
"success": true,
18-
"guild": {
19-
"_id": "536ac9ceed5032e412eb2ae1", // Guild ID
20-
"coins": 459178, // Number of coins this guild has - Deprecated
21-
"coinsEver": 619178, // Number of coins this guild has ever earned - Deprecated
22-
"created": 1399507406038, // Timestamp that this guild was created at
23-
"members": [{ // Member list
24-
"uuid": "e72660b18b88424ea23f2cdd3597c581", // This user's non-dashed UUID
25-
"rank": "GUILDMASTER", // This user's rank in this guild
26-
"joined": 1512200875108, // Timestamp the member joined
27-
"dailyCoins-12-6-2018": 1560, // Guild coins earned by this user on any given day - Deprecated
28-
"questParticipation": 4, // The number of challenges completed that count towards the current quest
29-
"mutedTill":1532797185516, // Timestamp that this user will be unmuted at
30-
"expHistory": {
31-
"2019-10-17": 17260 // Last 7 days of exp earned for this member
32-
}
33-
}, {
34-
"uuid": "6407035ace144175a731fac937d410cd",
35-
"rank": "Co-Owner",
36-
"joined": 1512074687198,
37-
"last_rank_modification": { // Data for last changes to this users rank
38-
"at": 1532715237290, // Timestamp the rank was changed
39-
"uuid": "e72660b18b88424ea23f2cdd3597c581" // User the rank was changed by
40-
},
41-
"expHistory": {
42-
"2019-10-17": 15812
43-
}
44-
}
45-
// ...
46-
],
47-
"name": "Froggy", // Name of this guild
48-
"name_lower": "froggy" // Name of this guild in all lower case
49-
"tagColor": "DARK_GREEN", // Color of this guild's guild tag, if set
50-
"joinable": false, // Whether this guild can be joined using /g join
51-
"legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed)
52-
"exp": 619178, // Total experience this guild has
53-
"description": "This guild is cool \u0026 fun!", // Description of this guild that appears in the guild list and /g info
54-
"achievements": { // Guild achievements earned and the current progress
55-
"WINNERS": 803,
56-
"EXPERIENCE_KINGS": 243576
57-
// ...
58-
},
59-
"ranks": [{
60-
"name": "Member", // Display name
61-
"permissions": [], // Array of the IDs of permissions this rank has
62-
"default": true, // Whether this rank is the defualt rank a user gets when they join a guild
63-
"tag": null, // Rank tag that appears in guild chat, or null if none
64-
"created": 1532713597406, // Timestamp of rank creation
65-
"priority": 1 // Rank priority - Higher number = higher up in the heirarchy
66-
}, {
67-
"name": "Co-Owner",
68-
"permissions": [5, 6, 7, 8, 9, 10, 11],
69-
"default": false,
70-
"tag": "CO",
71-
"created": 1532715059862,
72-
"priority": 2
73-
}
74-
// ...
75-
],
76-
"banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page
77-
// See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs
78-
"Base": "0", // Base color
79-
"Patterns": [ // Array of each layer on the banner pattern
80-
{
81-
"Pattern": "vhr", // Pattern ID for this layer
82-
"Color": "15" // Color of this layer (16-color 0-indexed pallete)
83-
}, {
84-
"Pattern": "vh",
85-
"Color": "15"
86-
}
87-
// ...
88-
]
89-
},
90-
"guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in
91-
"SKYWARS": 173,
92-
"PROTOTYPE": 3100,
93-
"BUILD_BATTLE": 46095
94-
// ...
95-
},
96-
"tag": "HYPIXL", // This guild's Guild tag
97-
"preferredGames": ["ARCADE", "SPEED_UHC", "UHC"], // This guild's set preferred games
98-
"chatThrottle": 10000, // Number of milliseconds users must wait between messages
99-
"vipCount": 22, // The number of players in the guild with VIP or VIP+ (Unreliable)
100-
"mvpCount": 39, // The number of players in the guild with MVP or higher (Unreliable)
101-
"publiclyListed": false, // Whether the guild is listed in the Guild Finder or not
102-
"chatMute": 1532797565473 // Timestamp that the entire guild chat will be unmuted at
103-
}
17+
"success": true,
18+
"guild": {
19+
"_id": "52e57a1c0cf2e250d1cd00f8", // Guild ID
20+
"created": 1390770716373, // Timestamp this guild was created at
21+
"name": "The Sloths",
22+
"name_lower": "the sloths",
23+
"description": "The sloths", // Description of this guild that appears in the guild list and /g info
24+
"tag": "SLOTH",
25+
"tagColor": "DARK_AQUA", // Color of this guild's tag, if set
26+
"exp": 2238673,
27+
"members": [
28+
{
29+
"uuid": "f7c77d999f154a66a87dc4a51ef30d19",
30+
"rank": "GUILDMASTER",
31+
"joined": 1390770716373, // Timestamp this member joined at
32+
"expHistory": { // Last 7 days of exp earned by this member
33+
"2020-05-25": 108,
34+
"2020-05-24": 404
35+
},
36+
"questParticipation": 4, // The number of challenges completed that count towards the current quest
37+
"mutedTill": 1399507406038 // Timestamp this member will be unmuted at
38+
}
39+
],
40+
"achievements": { // Guild achievements earned and the current progress
41+
"ONLINE_PLAYERS": 4,
42+
"EXPERIENCE_KINGS": 40062,
43+
"WINNERS": 2
44+
},
45+
"ranks": [
46+
{
47+
"name": "Member",
48+
"default": true, // Whether this rank is the defualt rank a player gets when they join a guild
49+
"created": 1, // Timestamp this rank was created at
50+
"priority": 1, // Rank priority - Higher number = higher up in the heirarchy
51+
"tag": "Member" // Rank tag that appears in guild chat, or null if none
52+
}
53+
],
54+
"joinable": true, // Whether this guild can be joined using /g join
55+
"legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed)
56+
"publiclyListed": false, // Whether this guild is listed in the Guild Finder
57+
"hideGmTag": true, // Whether guild master tag is hidden in guild chat
58+
"preferredGames": [ // This guild's set preferred games
59+
"ARCADE",
60+
"SPEED_UHC",
61+
"UHC"
62+
],
63+
"chatMute": 1590703490783, // Timestamp guild chat will be unmuted at, or 0 if guild chat is not muted
64+
"guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in
65+
"TNTGAMES": 1312,
66+
"VAMPIREZ": 4495,
67+
"ARCADE": 10285
68+
},
69+
"banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page
70+
// See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs
71+
"Base": "0", // Base color
72+
"Patterns": [ // Array of each layer on the banner pattern
73+
{
74+
"Pattern": "vhr", // Pattern ID for this layer
75+
"Color": "15" // Color of this layer (16-color 0-indexed pallete)
76+
},
77+
{
78+
"Pattern": "vh",
79+
"Color": "15"
80+
}
81+
]
82+
}
83+
}
10484
}
10585
```

‎Documentation/methods/key.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,15 @@ Returns information regarding given key.
77
- key
88

99
## Example Response
10-
```php
10+
```js
1111
{
12-
"key": "",
13-
"ownerUuid": "", // not dashed
14-
"totalQueries": 142028083,
15-
"queriesInPastMin": 68
16-
}
17-
```
12+
"success": true,
13+
"record": {
14+
"key": "e1513542-f4c7-483d-bf1b-3b29d4e59903",
15+
"owner": "8ffb79fa-620e-45fe-8d62-381abd5bc60f",
16+
"limit": 120, // Limit of requests per minute
17+
"queriesInPastMin": 0, // Does not include this query
18+
"totalQueries": 849
19+
}
20+
}
21+
```

‎Documentation/methods/leaderboards.md‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,26 @@ Returns a list of the official leaderboards and their current standings for game
77
## Parameters
88
- key
99

10-
## Example Leaderboard
11-
```php
10+
## Example Response
11+
```js
1212
{
13-
"TNTGAMES": [
14-
{
15-
"path": "wins_tntrun",
16-
"prefix": "Overall",
17-
"count": 10, // Number of properties in "leaders"
18-
"location": "-2554,57,715", // Coordinates of the board in the lobby
19-
"leaders": [
20-
"494a5e4a-ecd1-4a16-b9ee-de37ef24820d",
21-
"adc9fbdd-ede0-4ce9-8abf-42a97148bdbf",
22-
"222c4837-a906-40ed-a1fb-5713a70c13db",
23-
...
24-
],
25-
"title": "TNT Run Wins"
26-
},
27-
...
28-
]
13+
"success": true,
14+
"leaderboards": {
15+
"SKYWARS": [
16+
{
17+
"path": "wins",
18+
"prefix": "Overall",
19+
"title": "Wins",
20+
"location": "-2556,55,712", // Coordinates of the board in the lobby
21+
"count": 14,
22+
"leaders": [
23+
"2afdb69c-c007-40cd-98b9-76a7554612d9",
24+
"6951ccdb-9ca7-4c8a-883b-a8d3bb81c3d2",
25+
"e61044cc-c42f-439b-9ad7-817c51ae7174",
26+
...
27+
]
28+
}
29+
]
30+
}
2931
}
3032
```

0 commit comments

Comments
 (0)