Skip to content

Endpoints

Auth: Bearer token (all endpoints below)

Base path: /v1/pdapi

Content-Type: application/json (for POST requests)

Method Endpoint Description Permissions Details
GET /v1/pdapi/players List all players. REST.Players.Read GET /players
GET /v1/pdapi/player/<player_identifier> Show one player. REST.Player.Read GET /player
GET /v1/pdapi/pals/<player_identifier> List a player's Pals. REST.Pals.Read GET /pals
GET /v1/pdapi/items/<player_identifier> List a player's items. REST.Items.Read GET /items
GET /v1/pdapi/techs/<player_identifier> List a player's technologies. REST.Techs.Read GET /techs
GET /v1/pdapi/progression/<player_identifier> Show progression values. REST.Progression.Read GET /progression
GET /v1/pdapi/guilds List guilds. REST.Guilds.Read GET /guilds
GET /v1/pdapi/guild/<guild_id> Show one guild. REST.Guild.Read GET /guild
GET /v1/pdapi/banlist Search ban records. REST.Banlist.Read GET /banlist
GET /v1/pdapi/version Check API health/version. REST.Version.Read GET /version
Deprecated POST /v1/pdapi/give Legacy atomic reward grant. Deprecated legacy route. Use the split reward endpoints below. POST /give deprecated
POST /v1/pdapi/give/items/<player_identifier> Give items. REST.Items.Give POST /give/items
POST /v1/pdapi/give/pals/<player_identifier> Give Pals by ID. REST.Pals.Give POST /give/pals
POST /v1/pdapi/give/paltemplate/<player_identifier> Give template Pals. REST.PalTemplates.Give POST /give/paltemplate
POST /v1/pdapi/give/paleggs/<player_identifier> Give Pal eggs. REST.PalEggs.Give POST /give/paleggs
POST /v1/pdapi/give/progression/<player_identifier> Add EXP and points. REST.Progression.Give POST /give/progression
POST /v1/pdapi/learntech/<player_identifier> Learn technologies. REST.Techs.Learn POST /learntech
POST /v1/pdapi/forgettech/<player_identifier> Forget technologies. REST.Techs.Forget POST /forgettech
POST /v1/pdapi/deletebase/<base_camp_id> Delete a base/camp. REST.Base.Delete POST /deletebase
POST /v1/pdapi/ban/<player_identifier> Ban a user. REST.Punishments.Ban POST /ban
POST /v1/pdapi/unban/<user_id> Remove a user ban. REST.Punishments.Unban POST /unban
POST /v1/pdapi/banip/<ip> Ban an IP. REST.Punishments.BanIP POST /banip
POST /v1/pdapi/unbanip/<ip> Remove an IP ban. REST.Punishments.UnbanIP POST /unbanip
POST /v1/pdapi/kick/<player_identifier> Kick a player. REST.Punishments.Kick POST /kick
POST /v1/pdapi/SendPlayerMessage Send player messages. REST.Messages.Send.PlayerChat
REST.Messages.Send.GlobalChat
REST.Messages.Send.GuildChat
REST.Messages.Send.Log.Normal
REST.Messages.Send.Log.Important
REST.Messages.Send.Log.VeryImportant
POST /SendPlayerMessage
POST /v1/pdapi/Broadcast Broadcast chat. REST.Messages.Broadcast POST /Broadcast
POST /v1/pdapi/Alert Send an alert. REST.Messages.Alert POST /Alert
POST /v1/pdapi/ReloadConfig Reload config. REST.Reload.Config POST /ReloadConfig