Skip to main content

Developer API

dzbot exposes a REST API that lets external applications read and interact with your server's data programmatically. You can use it to build Discord bots, dashboards, custom integrations, or automated tooling on top of dzbot.

Interactive API reference: apidocs.dzbot.de

Authentication​

The API uses API key authentication. Every request must include your key as a Bearer token in the Authorization header:

Authorization: Bearer <your-api-key>

API keys are scoped to a single server. A request made with a key for server A cannot access data belonging to server B.

Managing API Keys​

Navigation path:

  • Admin panel → Settings → API Keys

From there you can:

  • create a new API key (give it a descriptive label so you can identify it later)
  • copy the key immediately after creation — it is only shown once
  • revoke a key at any time to immediately invalidate it

Treat API keys like passwords. Do not commit them to source control or share them in public channels.

Base URL​

All endpoints are served under:

https://api.dzbot.de/api

What the API covers​

The API provides read and write access to the core dzbot data for your server. Common use cases include:

  • Players — look up player profiles, balances, session info, and group memberships
  • Orders & shop — query order history and item catalog
  • Factions — retrieve faction membership and treasury data
  • Server metadata — server status, settings, and configuration values

The full list of available endpoints, request parameters, and response schemas is in the interactive reference at apidocs.dzbot.de.

Example request​

curl https://api.dzbot.de/api/players \
  -H "Authorization: Bearer dzb_your_key_here"

Rate limits & fair use​

The API is intended for integration and automation use cases. Avoid polling at high frequency — use reasonable intervals (e.g. no more than once per minute for data that changes infrequently). Excessive usage may result in temporary rate limiting.

OpenAPI spec​

The machine-readable OpenAPI specification is available at:

https://api.dzbot.de/api/docs.json

You can import it into tools like Postman, Insomnia, or any OpenAPI-compatible client to generate a typed client for your language of choice.