Skip to content

Update all response examples #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 12, 2020
Merged

Update all response examples #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ef9108a
Update all examples
mdashlw May 30, 2020
bafc55b
More examples
mdashlw May 30, 2020
f593dc1
Remove ...
mdashlw May 30, 2020
7577e6b
Update key example
mdashlw May 30, 2020
32b5e30
Update guild example
mdashlw May 30, 2020
0a0336c
More explanation of recentGames and key
mdashlw May 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 30 additions & 18 deletions Documentation/methods/boosters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,36 @@ Returns list of boosters.
- key

## Example Response
```php
```js
{
"success": true,
"boosters": [
{
"purchaserUuid": "",
"amount": 3, // multiplier
"originalLength": 3600,
"length": 2329, // length remaining
"gameType": 20, // GameType ID
"dateActivated": 1471657389139 // unix timestamp
"stacked": [
"" // array of up to 10 UUIDs who have stacked the booster, or "true" if there are none
]
}
]
"boosterState": {
"decrementing": true // indicates whether booster duration is ticking down
}
"success": true,
"boosters": [
{
"_id": "5c197fadc8f245280926413d",
"purchaserUuid": "978ddb705a8e43618e41749178c020b0",
"amount": 2, // Multiplier
"originalLength": 3600,
"length": 3595, // Length remaining
"gameType": 24, // GameType ID
"dateActivated": 1545244519133,
"stacked": true
},
{
"_id": "5de1bf590cf2544cd01a7e04",
"purchaserUuid": "9e29fa1bedde445abb79526e22a7e051",
"amount": 2.2,
"originalLength": 3600,
"length": 2074,
"gameType": 13,
"dateActivated": 1590842991659,
"stacked": [ // Array of up to 10 UUIDs who have stacked the booster
"e8558c2a-935c-4eba-9a20-1e7eddeb2530",
"d33dbdc9-a65b-4090-ab20-d101452647fa"
]
}
],
"boosterState": {
"decrementing": true // Indicates whether booster duration is ticking down
}
}
```
10 changes: 9 additions & 1 deletion Documentation/methods/findGuild.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,13 @@ Returns the id of the requested guild.

## Parameters
- key
- byName _(Case sensitive, HTML encode spaces)_
- byName
- byUuid

## Example Response
```js
{
"success": true,
"guild": "553490650cf26f12ae5bac8f"
}
```
23 changes: 13 additions & 10 deletions Documentation/methods/friends.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# friends
# friends

## Description
Returns friendships for given player.
Expand All @@ -8,13 +8,16 @@ Returns friendships for given player.
- uuid

## Example Response
```php
[
```js
{
"success": true,
"records": [
{
"uuidSender": "",
"uuidReceiver": "",
"started": 1376865614794 // unix timestamp
},
...
]
```
"_id": "5eb97d170cf22f431e8d6170",
"uuidSender": "20934ef9488c465180a78f861586b4cf",
"uuidReceiver": "7486aa03aca5470e888dde8a43eb8c10",
"started": 1589214487454
}
]
}
```
40 changes: 23 additions & 17 deletions Documentation/methods/gameCounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
# gameCounts

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

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.

## Parameters
- key

## Example Player Count
```php
## Example Response
```js
{
"games": {
"BUILD_BATTLE": { // The GameType Name
"modes": {
"BUILD_BATTLE_HALLOWEEN": 82, // The mode key along with the player count
"BUILD_BATTLE_GUESS_THE_BUILD": 177,
"BUILD_BATTLE_TEAMS_NORMAL": 512,
"BUILD_BATTLE_SOLO_NORMAL": 440,
"BUILD_BATTLE_SOLO_PRO": 114
},
"players": 1453 // Total players for the GameType
}
},
"playerCount": 59715
"success": true,
"games": {
"SKYBLOCK": { // The GameType Name
"players": 30522, // Total players for the GameType
"modes": {
"combat_1": 690, // The mode key along with the player count
"foraging_1": 1456,
"hub": 8049,
"mining_2": 1062,
"combat_2": 277,
"farming_2": 247,
"mining_1": 300,
"farming_1": 204,
"combat_3": 2350,
"dynamic": 15888
}
}
},
"playerCount": 77238 // Total players on the network
}
```
158 changes: 69 additions & 89 deletions Documentation/methods/guild.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,95 +11,75 @@ See [`resources.md`](/Documentation/methods/resources.md) for a JSON list of Gui
- player (Lookup by Player UUID)
- name (Lookup by Guild name)

## Example
```php
## Example Response
```js
{
"success": true,
"guild": {
"_id": "536ac9ceed5032e412eb2ae1", // Guild ID
"coins": 459178, // Number of coins this guild has - Deprecated
"coinsEver": 619178, // Number of coins this guild has ever earned - Deprecated
"created": 1399507406038, // Timestamp that this guild was created at
"members": [{ // Member list
"uuid": "e72660b18b88424ea23f2cdd3597c581", // This user's non-dashed UUID
"rank": "GUILDMASTER", // This user's rank in this guild
"joined": 1512200875108, // Timestamp the member joined
"dailyCoins-12-6-2018": 1560, // Guild coins earned by this user on any given day - Deprecated
"questParticipation": 4, // The number of challenges completed that count towards the current quest
"mutedTill":1532797185516, // Timestamp that this user will be unmuted at
"expHistory": {
"2019-10-17": 17260 // Last 7 days of exp earned for this member
}
}, {
"uuid": "6407035ace144175a731fac937d410cd",
"rank": "Co-Owner",
"joined": 1512074687198,
"last_rank_modification": { // Data for last changes to this users rank
"at": 1532715237290, // Timestamp the rank was changed
"uuid": "e72660b18b88424ea23f2cdd3597c581" // User the rank was changed by
},
"expHistory": {
"2019-10-17": 15812
}
}
// ...
],
"name": "Froggy", // Name of this guild
"name_lower": "froggy" // Name of this guild in all lower case
"tagColor": "DARK_GREEN", // Color of this guild's guild tag, if set
"joinable": false, // Whether this guild can be joined using /g join
"legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed)
"exp": 619178, // Total experience this guild has
"description": "This guild is cool \u0026 fun!", // Description of this guild that appears in the guild list and /g info
"achievements": { // Guild achievements earned and the current progress
"WINNERS": 803,
"EXPERIENCE_KINGS": 243576
// ...
},
"ranks": [{
"name": "Member", // Display name
"permissions": [], // Array of the IDs of permissions this rank has
"default": true, // Whether this rank is the defualt rank a user gets when they join a guild
"tag": null, // Rank tag that appears in guild chat, or null if none
"created": 1532713597406, // Timestamp of rank creation
"priority": 1 // Rank priority - Higher number = higher up in the heirarchy
}, {
"name": "Co-Owner",
"permissions": [5, 6, 7, 8, 9, 10, 11],
"default": false,
"tag": "CO",
"created": 1532715059862,
"priority": 2
}
// ...
],
"banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page
// See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs
"Base": "0", // Base color
"Patterns": [ // Array of each layer on the banner pattern
{
"Pattern": "vhr", // Pattern ID for this layer
"Color": "15" // Color of this layer (16-color 0-indexed pallete)
}, {
"Pattern": "vh",
"Color": "15"
}
// ...
]
},
"guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in
"SKYWARS": 173,
"PROTOTYPE": 3100,
"BUILD_BATTLE": 46095
// ...
},
"tag": "HYPIXL", // This guild's Guild tag
"preferredGames": ["ARCADE", "SPEED_UHC", "UHC"], // This guild's set preferred games
"chatThrottle": 10000, // Number of milliseconds users must wait between messages
"vipCount": 22, // The number of players in the guild with VIP or VIP+ (Unreliable)
"mvpCount": 39, // The number of players in the guild with MVP or higher (Unreliable)
"publiclyListed": false, // Whether the guild is listed in the Guild Finder or not
"chatMute": 1532797565473 // Timestamp that the entire guild chat will be unmuted at
}
"success": true,
"guild": {
"_id": "52e57a1c0cf2e250d1cd00f8", // Guild ID
"created": 1390770716373, // Timestamp this guild was created at
"name": "The Sloths",
"name_lower": "the sloths",
"description": "The sloths", // Description of this guild that appears in the guild list and /g info
"tag": "SLOTH",
"tagColor": "DARK_AQUA", // Color of this guild's tag, if set
"exp": 2238673,
"members": [
{
"uuid": "f7c77d999f154a66a87dc4a51ef30d19",
"rank": "GUILDMASTER",
"joined": 1390770716373, // Timestamp this member joined at
"expHistory": { // Last 7 days of exp earned by this member
"2020-05-25": 108,
"2020-05-24": 404
},
"questParticipation": 4, // The number of challenges completed that count towards the current quest
"mutedTill": 1399507406038 // Timestamp this member will be unmuted at
}
],
"achievements": { // Guild achievements earned and the current progress
"ONLINE_PLAYERS": 4,
"EXPERIENCE_KINGS": 40062,
"WINNERS": 2
},
"ranks": [
{
"name": "Member",
"default": true, // Whether this rank is the defualt rank a player gets when they join a guild
"created": 1, // Timestamp this rank was created at
"priority": 1, // Rank priority - Higher number = higher up in the heirarchy
"tag": "Member" // Rank tag that appears in guild chat, or null if none
}
],
"joinable": true, // Whether this guild can be joined using /g join
"legacyRanking": 10446, // Ranking in the number of guild coins owned in the legacy guild system (0-indexed)
"publiclyListed": false, // Whether this guild is listed in the Guild Finder
"hideGmTag": true, // Whether guild master tag is hidden in guild chat
"preferredGames": [ // This guild's set preferred games
"ARCADE",
"SPEED_UHC",
"UHC"
],
"chatMute": 1590703490783, // Timestamp guild chat will be unmuted at, or 0 if guild chat is not muted
"guildExpByGameType": { // Amount of EXP earned for this guild by which game it was earned in
"TNTGAMES": 1312,
"VAMPIREZ": 4495,
"ARCADE": 10285
},
"banner": { // This guild's Minecraft banner - Displayed on the Hypixel forums page
// See https://minecraft.gamepedia.com/Banner/Patterns for pattern IDs
"Base": "0", // Base color
"Patterns": [ // Array of each layer on the banner pattern
{
"Pattern": "vhr", // Pattern ID for this layer
"Color": "15" // Color of this layer (16-color 0-indexed pallete)
},
{
"Pattern": "vh",
"Color": "15"
}
]
}
}
}
```
18 changes: 11 additions & 7 deletions Documentation/methods/key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@ Returns information regarding given key.
- key

## Example Response
```php
```js
{
"key": "",
"ownerUuid": "", // not dashed
"totalQueries": 142028083,
"queriesInPastMin": 68
}
```
"success": true,
"record": {
"key": "e1513542-f4c7-483d-bf1b-3b29d4e59903",
"owner": "8ffb79fa-620e-45fe-8d62-381abd5bc60f",
"limit": 120, // Limit of requests per minute
"queriesInPastMin": 0, // Does not include this query
"totalQueries": 849
}
}
```
38 changes: 20 additions & 18 deletions Documentation/methods/leaderboards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,26 @@ Returns a list of the official leaderboards and their current standings for game
## Parameters
- key

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