McQuery API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Content

Player

World

Content

Up
get /content
Returns a list of loaded content (contentGet)
Returns a complete list of all Blocks/Items currently loaded into the game

Return type

array[ItemStack]

Example data

Content-Type: application/json
[ {
  "itemGroup" : "itemGroup",
  "damage" : 6.027456183070403,
  "capabilityTag" : { },
  "item" : "item",
  "displayName" : "displayName",
  "maxDamage" : 1.4658129805029452,
  "isEmpty" : true,
  "count" : 0.8008281904610115,
  "tag" : { }
}, {
  "itemGroup" : "itemGroup",
  "damage" : 6.027456183070403,
  "capabilityTag" : { },
  "item" : "item",
  "displayName" : "displayName",
  "maxDamage" : 1.4658129805029452,
  "isEmpty" : true,
  "count" : 0.8008281904610115,
  "tag" : { }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Player

Up
get /players
Returns a list of online players (playersGet)

Return type

array[PlayerEntityStub]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /players/{playerId}
Returns detailed information about a specific player (playersPlayerIdGet)

Path parameters

playerId (required)
Path Parameter — Player's Minecraft UUID

Return type

PlayerEntity

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PlayerEntity

Up
get /players/{playerId}/inventories
Returns detailed information about a specific player's inventory (playersPlayerIdInventoriesGet)

Path parameters

playerId (required)
Path Parameter — Player's Minecraft UUID

Return type

PlayerInventory

Example data

Content-Type: application/json
{
  "enderChestInventory" : [ null, null ],
  "playerInventory" : [ {
    "itemGroup" : "itemGroup",
    "damage" : 6.027456183070403,
    "capabilityTag" : { },
    "item" : "item",
    "displayName" : "displayName",
    "maxDamage" : 1.4658129805029452,
    "isEmpty" : true,
    "count" : 0.8008281904610115,
    "tag" : { }
  }, {
    "itemGroup" : "itemGroup",
    "damage" : 6.027456183070403,
    "capabilityTag" : { },
    "item" : "item",
    "displayName" : "displayName",
    "maxDamage" : 1.4658129805029452,
    "isEmpty" : true,
    "count" : 0.8008281904610115,
    "tag" : { }
  } ],
  "hotbar" : {
    "inventory" : [ null, null ],
    "selectedIndex" : 0.8008281904610115
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PlayerInventory

World

Up
get /worlds
Returns a list of loaded dimensions (worldsGet)

Return type

array[WorldStub]

Example data

Content-Type: application/json
[ {
  "difficulty" : "peaceful",
  "seed" : 0.8008281904610115,
  "name" : "name",
  "raining" : true,
  "thundering" : true,
  "type" : "type"
}, {
  "difficulty" : "peaceful",
  "seed" : 0.8008281904610115,
  "name" : "name",
  "raining" : true,
  "thundering" : true,
  "type" : "type"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /worlds/{worldName}/blocks/{xyz}
Returns information about the block at the requested coordinates (worldsWorldNameBlocksXyzGet)

Path parameters

worldName (required)
Path Parameter — World name (ex. minecraft:overworld)
xyz (required)
Path Parameter — The desired X, Y, and Z coordinate, seperated by commas

Return type

BlockState

Example data

Content-Type: application/json
{
  "name" : "name",
  "position" : {
    "x" : 0.8008281904610115,
    "y" : 6.027456183070403,
    "z" : 1.4658129805029452
  },
  "properties" : { },
  "tileEntity" : {
    "tag" : { },
    "type" : "type"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BlockState

Up
get /worlds/{worldName}/entities
Returns a list of all entities active in the world (worldsWorldNameEntitiesGet)

Path parameters

worldName (required)
Path Parameter — World name (ex. minecraft:overworld)

Return type

array[Entity]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "x" : 0.8008281904610115,
  "y" : 6.027456183070403,
  "z" : 1.4658129805029452,
  "classification" : "classification",
  "uuid" : "uuid"
}, {
  "name" : "name",
  "x" : 0.8008281904610115,
  "y" : 6.027456183070403,
  "z" : 1.4658129805029452,
  "classification" : "classification",
  "uuid" : "uuid"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /worlds/{worldName}
Returns a specific World by ID (worldsWorldNameGet)

Path parameters

worldName (required)
Path Parameter — World name (ex. minecraft:overworld)

Return type

World

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

World

Models

[ Jump to Methods ]

Table of Contents

  1. BlockPos
  2. BlockState
  3. Entity
  4. GameProfile
  5. ItemStack
  6. LivingEntity
  7. LivingEntity_equipment
  8. PlayerEntity
  9. PlayerEntityStub
  10. PlayerHotbar
  11. PlayerInventory
  12. Potion
  13. PotionInstance
  14. TileEntity
  15. World
  16. WorldStub

BlockPos Up

x (optional)
y (optional)
z (optional)

BlockState Up

name (optional)
position (optional)
properties (optional)
tileEntity (optional)

Entity Up

uuid (optional)
name (optional)
classification (optional)
x (optional)
y (optional)
z (optional)

GameProfile Up

id (optional)
name (optional)
properties (optional)

ItemStack Up

item (optional)
displayName (optional)
itemGroup (optional)
isEmpty (optional)
count (optional)
damage (optional)
maxDamage (optional)
tag (optional)
capabilityTag (optional)

LivingEntity Up

uuid (optional)
name (optional)
classification (optional)
x (optional)
y (optional)
z (optional)
health (optional)
maxHealth (optional)
attributes (optional)
potionEffects (optional)
equipment (optional)

LivingEntity_equipment Up

head (optional)
chest (optional)
legs (optional)
feet (optional)
mainhand (optional)
offhand (optional)

PlayerEntity Up

gameProfile (optional)

PlayerEntityStub Up

health (optional)
maxHealth (optional)
attributes (optional)
potionEffects (optional)
equipment (optional)
gameProfile (optional)

PlayerHotbar Up

selectedIndex (optional)
inventory (optional)

PlayerInventory Up

playerInventory (optional)
enderChestInventory (optional)
hotbar (optional)

Potion Up

name (optional)
type (optional)
Enum:
beneficial
harmful
neutral

PotionInstance Up

potion (optional)
duration (optional)
amplifier (optional)

TileEntity Up

type (optional)
tag (optional)

World Up

type (optional)
name (optional)
seed (optional)
raining (optional)
thundering (optional)
difficulty (optional)
Enum:
peaceful
easy
medium
hard

WorldStub Up

type (optional)
name (optional)
seed (optional)
raining (optional)
thundering (optional)
difficulty (optional)
Enum:
peaceful
easy
medium
hard