💎⛏️ Minecraft API - Documentation 💎⛏️

Welcome to the Minecraft API documentation. Here you will find all the information you need to use our API and application.This API only make GET actions because we only give information about Minecraft datas. You can access to the API using the next endpoint.

/api/

⚒ Introduction

The Minecraft API allows you to access various data types related to the game, such as advancements, biomes, blocks, items, mobs, and structures. There are two components: This that show all information of the game where you can access to this with the information section or with the terminal, and the API which you can use into your projects. The dedicated API reference now lives in /docs, where you can inspect the available route templates and execute real requests.

💎 API Routes

Here are the available API routes:

Also, for each API controller, you can access to the next endpoints:

  • / Access to all the information of a entity
  • /count Give the amount of datas present in a entity
  • /keys Obtain the keys availables of a entity
  • /:id Get the information of a entity by Id
  • /:id/image Get the image of a entity
  • /all/:key Show all datas only with a key
  • /all/:key/:value Filter datas by a key and value
  • /:id/:key Show the value of the key of a data

⚔️ Examples of Use

You can test the Minecraft API directly from this page or open the dedicated endpoint explorer in /docs. Both experiences are backed by the same live routes and the generated OpenAPI specification exposed in /api/openapi.

⛏ Issues

If you found some bugs with the application and the API, you can open a Issue in the GitHub repository.

👷 Community

Because the application manages large amounts of data and variables of the entities present in Minecraft, many of the data presented in the application are not correct. Therefore, I encourage them to collaborate with the correction of data, especially corrected data of the blocks and items, add more information to each entity. For example, for the blocks and items it is necessary to fill the information with crafts, and in other entities there are empty fields that need to be filled. Also, it is necessary to add the data of the new versions of Minecraft. So far there is data until 1.19. Preferably, the information present in Minecraft Wiki must be taken as a basis. If you want to collaborate with the development of the application, visit the GitHub repository, you can create a new branch with git, develop your contribution and upload the PR like an Issue. The objective of this application is that it is a more accessible information base for the community and developers. Likewise, any code improvement contribution will be welcome.

🏹 Special Thanks

  • Minecraft Wiki: Some of the assets provides by the API has been obtained from the Minecraft Wiki
  • anish-shanbhag: Some values and assets of the datas provides by the API has been obtained from the Minecraft API by anish-shanbhag. You can check the link for the API, clicking here!
    And you can check the GitHub repository!: https://github.com/anish-shanbhag/minecraft-api