Skip to content

SpraxDev/Api.Sprax2013.de

Repository files navigation

Api.Sprax2013.de SpraxAPI Logo

Security Rating Lines of Code Discord-Chat

Api.Sprax2013.de or SpraxAPI for short is a collection of different public APIs that everyone can use.

SpraxAPI started as a private API in PHP to ensure my projects keep working without hitting the rate limit for some APIs. As soon as I discoverd Node.js, I quickly felt confident that my API can handle requests from the public (performance and security). And currently servers over 2,000,000 request a month (as of the 4th May 2020).

You currently can request all sort of Minecraft related things without hitting any rate limitations. My API achieves this thanks to CloudFlare and internal caching of responses. Additionally, you can request processed version of this data. For example Skins upgraded to the 1.8 format (64x64 pixels) or a (2D/3D) rendered Version of it.

Another API for Minecraft?

Yes, but did you use any of the known other ones? Only allowing UUIDs, caching for multiple minutes or hours, not allowing for accurate data in some use cases? Or even long response times and huge response body size?

They are not bad but they could be better. So I'm offering a public and Open Source Version alternative, trying to not cause too much traffic (Mojang has to pay bills too!) while providing an helpful and easy to use API.

I'm currently working on SkinDB. It will make great use of this API and provide an intuitive interface for people who don't want to use this API or don't know how.

What about privacy?

It aims to be highly transparent to everyone. Thanks to this transparency it is easily compliant with most data protection laws e.g. the GDPR.

This API provides data in JSON format. I can't even display an ad in some corner if I wanted to. (consider supporting me on Patreon)

Setup

You'll need Node.js and npm on your machine and a PostgreSQL instance

  1. Prepare your PostgreSQL server by running the commands inside ./tables.sql (coming soon)
  2. npm install
  3. npm run build
  4. npm run start or npm run start-headless on machines without GPU
  5. Configure all files inside ./storage/ (automatically generated)
  6. Type rs into the console or restart the process

Can't run? You might need to install some dependencies found here and here too

Setup for development

  1. Follow the Setup section until 2nd step.
  2. Use npm run dev to run without creating an output dir (autorestart on file changes)

Thanks To... ✨

JNSAPH GitHub-Logo
🎨JonasAlpha
NudelErde GitHub-Logo
💻NudelErde
CloudFlare branding
CloudFlare Free
JetBrains branding
JetBrains OS License

License

MIT License