DZDEV OpenAPIDocs
// API

The dzbot API

Everything your dzbot server holds — players, wallets, orders, factions, tickets — for your own Discord bot, dashboard or script. The API is the one the dzbot app itself runs on.

Open the reference Lists and search

// AuthenticationAPI keys

Every request carries an API key as a bearer token:

Authorization: Bearer dzb_your_key_here

Create keys in the admin area of your server under Developers. Give each key a note so you know later what uses it, copy it right away — the full key is only shown once — and delete it to revoke it at once. Treat keys like passwords: never commit them or post them in public channels.

A key belongs to one server and carries its own list of access rights: it reaches exactly what those rights open, nothing of another server. On a server with ticket support levels, a key also needs the matching admin.tickets.level_<id> right — without any level right it sees no tickets at all.

// RequestsBase URL and server

All endpoints live under

https://api.dzbot.de/api

and every request names its server in the X-Server-Subdomain header — the subdomain of your server's dzbot page:

curl "https://api.dzbot.de/api/admin/search/player?q=Survivor" \
  -H "Authorization: Bearer dzb_your_key_here" \
  -H "X-Server-Subdomain: your-server"

A player's wallet balance belongs to the organization: it is one balance shared by all servers of the organization.

// ScopeWhat the API covers

Players

Profiles, wallets and transactions, groups, notes, restrictions.

Shop

Orders, the item catalogue, kits, subscriptions and coupons.

Server

Factions, bases, zones, tickets, logs, settings and the rest of the admin area.

Every list is read through one search endpoint — see Lists and search. Reading one row, creating, changing and deleting each have their own endpoint in the reference.

// Fair useRate limits

The API is made for integrations and automation. Don't poll at high frequency — for data that changes rarely, once a minute is plenty. Excessive traffic may be rate limited for a while.

// Machine-readableOpenAPI

The OpenAPI specification is at

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

Import it into Postman, Insomnia or any OpenAPI generator to get a typed client for your language. The reference renders the same file.