HTTP API
Goxy exposes a public HTTP API at api.goxy.pl for external integrations. Use it from any backend, bot, dashboard or script that needs to read or control network data - without running a Minecraft plugin.
↔️Looking for the in-game Java SDK?
This page covers the HTTP API. If you are writing a Bukkit/Spigot/Paper/Velocity plugin that runs inside a Minecraft server, use the Plugin API (Java SDK) instead - it gives you direct access without going through HTTP.
What is available
| Style | Endpoint | Best for |
|---|---|---|
| REST | https://api.goxy.pl/ | Simple request/response, one-off reads, command-style writes |
| GraphQL | https://api.goxy.pl/graphql | Fetching exactly the fields you need, fewer round-trips, typed schema |
Both styles expose the same underlying data - pick whichever fits your tooling.
Interactive documentation
The full reference is available as live, browsable documentation:
| Tool | URL | Notes |
|---|---|---|
| Swagger UI | api.goxy.pl/swagger-ui.html | Classic try-it-out REST explorer |
| Redoc | api.goxy.pl/docs/redoc.html | Reference-style REST docs, great for reading |
| Rapidoc | api.goxy.pl/docs/rapidoc.html | Compact alternative REST viewer |
| GraphiQL | api.goxy.pl/docs/graphiql.html | Interactive GraphQL playground with schema introspection |
🧪Try before you build
Start in GraphiQL or Swagger UI to explore the schema and craft your first query before wiring it into your code.
When to use what
- Use the Plugin API (Java SDK) when you are inside a Minecraft server plugin - it's faster (in-process), strongly typed, and gives you access to events.
- Use the HTTP API for everything that runs outside the game server: Discord bots, custom dashboards, billing/CRM integrations, mobile apps, monitoring scripts, etc.
- Use the custom webhook if you only need to control where players land on join - that's a lighter alternative to the full HTTP API.
Links
🌐 Our website is available at goxy.io
🖥️ Goxy dashboard is available here
⏳ Suspect a breakdown? Check our status page
💬 Want more about Goxy? Head to Discord
🤩 Look at the awesome curated list
📘 Read the API documentation