https://github.com/anish-shanbhag/minecraft-api

An API for getting information about the game Minecraft.
https://github.com/anish-shanbhag/minecraft-api

api database minecraft rest rest-api

Last synced: 2 months ago
JSON representation

An API for getting information about the game Minecraft.

• Host: GitHub
• URL: https://github.com/anish-shanbhag/minecraft-api
• Owner: anish-shanbhag
• Created: 2020-04-08T03:38:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-26T22:48:02.000Z (over 1 year ago)
• Last Synced: 2024-04-28T05:37:36.592Z (8 months ago)
• Topics: api, database, minecraft, rest, rest-api
• Language: TypeScript
• Homepage: https://anish-shanbhag.stoplight.io/docs/minecraft-api
• Size: 31.9 MB
• Stars: 21
• Watchers: 2
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# The Minecraft API

This is the repository for the (unofficial) Minecraft API!

The aim of this API is to provide you with access to all sorts of information about the game Minecraft. This includes things like images, descriptions, stats, technical details, and much more. Currently, the API has endpoints for information about items, blocks, and crafting recipes, but more is planned for the future. The API is up to date for Minecraft Java Edition 1.18. At this time, 1.19 data isn't available since the Minecraft Wiki (where the data is pulled from) hasn't updated its website yet.

# Documentation

You can find detailed documentation for the API [here](https://anish-shanbhag.stoplight.io/docs/minecraft-api).

# Endpoints

The root endpoint of the API is https://minecraft-api.vercel.app/api.

To form requests to the API, append the path of the resource you want to the end of the root endpoint. As an example, a simple request to get information about all of the items in Minecraft would be https://minecraft-api.vercel.app/api/items. This request would return the following JSON:

```json

[

  {

    "name": "Acacia Boat",

    "namespacedId": "acacia_boat",

    "description": "A boat is both an item and a vehicle entity.",

    "image": "https://minecraft-api.vercel.app/images/items/acacia_boat.png",

    "stackSize": 1,

    "renewable": true

  },

  {

    "name": "Acacia Button",

    "namespacedId": "acacia_button",

    "description": "A button is a non-solid block that can provide temporary redstone power.",

    "image": "https://minecraft-api.vercel.app/images/items/acacia_button.png",

    "stackSize": 64,

    "renewable": true

  },

  {

    "name": "Acacia Door",

    "namespacedId": "acacia_door",

    "description": "A door is a block that can be used as a barrier that can be opened by hand or with redstone.",

    "image": "https://minecraft-api.vercel.app/images/items/acacia_door.png",

    "stackSize": 64,

    "renewable": true

  },

  ...

]

```

# A Note About Development

This project is currently a work in progress, and so there may be errors in the documentation or bugs in the API. If you find one, you can help me out by creating an issue in the [GitHub repository](https://github.com/anish-shanbhag/minecraft-api).