Skip to content

API for retrieving information for Minecraft items, blocks, effects, and biomes.

License

Notifications You must be signed in to change notification settings

PetarMc1/Minecraft-Items-API-v2

Repository files navigation

Minecraft Items API v2

Warning

Minecraft Items API v2 reached End of Life and is no longer supported!

Discord GitHub Release GitHub Issues Pull Requests GitHub License

Welcome to the Minecraft Items API v2! This API provides comprehensive access to information about items, blocks, effects, and other things in Minecraft, from version 1.9 to the latest release.

How to get API running on your local machine for development.

You need pnmp to run the API locally!

Local Development

  1. Clone the repository (only the master branch). If you plan to make changes, create a fork first!
git clone https://github.com/PetarMc1/Minecraft-Items-API-v2 -b master
  1. Install all required dependencies.
pnpm install
  1. Start the development server
pnpm dev

This will start a local development server. The majority of changes will be instantly reflected live without the need to restart the development server or reload the page in your browser.

Building

pnpm build

This command builds a production-ready deployment into the build directory. These files are ready to be hosted on any static content server.

Usage

https://mc-api.petarmc.com

Begin your journey with the Minecraft Items API v2 by making HTTP requests to the endpoint. Explore the API documentation for comprehensive details on available endpoints, request parameters, and response formats.

Contributing

Check CONTRIBUITNG.md

License

This project is licensed under the MIT License.

Everything in the Data folder is copied from PrismarineJS/minecraft-data