API Documentation

Register a new player account.

Creates a new player with 1000 starting currency and an empty unit roster. Returns a JWT token you can use immediately to start building your army. Usernames must be unique and between 3-50 characters. Passwords require at least 8 characters.

{
  "username": "DragonSlayer42",
  "email": "player@example.com",
  "password": "SecurePass123!"
}

{
  "playerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "username": "DragonSlayer42",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresAt": "2025-06-15T15:30:00Z"
}

Authenticate and receive a JWT token.

Returns a JWT Bearer token valid for 60 minutes. Include it in the Authorization header of all subsequent requests as `Bearer <token>`.

{
  "username": "DragonSlayer42",
  "password": "SecurePass123!"
}

{
  "playerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "username": "DragonSlayer42",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresAt": "2025-06-15T16:30:00Z"
}

Refresh an expiring JWT token.

Exchange your current valid token for a fresh one with a new expiration. Call this before your token expires to maintain an active session without re-entering credentials.

Get your player profile.

Returns your account details including level, currency balance, API rating, and counts of owned units and configured teams.

List all units in your roster.

Returns every unit you own, including their stats, class, and abilities. These are the combatants available for team composition.

Unlock a new unit from the template roster.

Spend in-game currency to add a template unit to your roster. Each unit can only be unlocked once. Check available units and costs at GET /api/v1/player/roster/available.

{
  "templateUnitId": "b7e4f2a1-9c38-4d56-a1e2-3f4b5c6d7e8f"
}

{
  "id": "d4c3b2a1-8f7e-6d5c-4b3a-2e1f0a9b8c7d",
  "name": "Iron Vanguard",
  "class": "Warrior",
  "health": 120,
  "attack": 25,
  "defense": 30,
  "speed": 10,
  "currencyRemaining": 700
}

Browse the unit shop.

Lists all template units available for purchase, with stats, class, abilities, and unlock cost. Units you already own are excluded.

Get your achievements.

Returns all achievements with your progress toward each one. Secret achievements are hidden until unlocked.

Get your unread notification count.

Get your notifications.

Mark a notification as read.

Mark all notifications as read.

Get your notification preferences.

Update your notification preferences.

Get notification digest (summary grouped by category).

Returns a compact digest of all unread notifications grouped by category, with counts and the 10 most recent highlights. Use this for a quick status check instead of paginating through all notifications.

Create a new team.

Assemble a squad of 1-5 units from your roster and optionally assign a battle strategy. Teams are your entry ticket to battle — you cannot queue without one. The strategy object controls how your units behave in combat: formation, target priority, and conditional ability usage. If omitted, units use default AI behavior.

{
  "name": "Alpha Strike Force",
  "unitIds": [
    "d4c3b2a1-8f7e-6d5c-4b3a-2e1f0a9b8c7d",
    "e5d4c3b2-9a8f-7e6d-5c4b-3a2e1f0a9b8c",
    "f6e5d4c3-ab9a-8f7e-6d5c-4b3a2e1f0a9b"
  ],
  "strategy": {
    "formation": "defensive",
    "targetPriority": "weakest",
    "abilityRules": [
      {
        "condition": "allyHpBelow",
        "threshold": 30,
        "action": "useHeal"
      }
    ]
  }
}

{
  "id": "c8a7b6d5-4e3f-2a1b-9c8d-7e6f5a4b3c2d",
  "name": "Alpha Strike Force",
  "units": [
    {
      "id": "d4c3b2a1-8f7e-6d5c-4b3a-2e1f0a9b8c7d",
      "name": "Iron Vanguard",
      "class": "Warrior",
      "level": 1,
      "health": 120,
      "attack": 25,
      "defense": 30,
      "speed": 10
    }
  ],
  "strategy": {
    "formation": "defensive",
    "targetPriority": "weakest"
  },
  "createdAt": "2025-06-15T14:30:00Z",
  "updatedAt": "2025-06-15T14:30:00Z"
}

Get a specific team by ID.

Update an existing team.

Replace the team's name, unit composition, and/or strategy. Send the complete desired state — this is a full replacement, not a partial update.

Delete a team.

Permanently removes a team configuration. The units themselves remain in your roster.

List all your teams.

Returns every team you have configured, each with full unit details and strategy.

Enter the battle queue.

Submit a team to the matchmaking queue. The system pairs you with an opponent of similar rating. Battles resolve asynchronously — poll the status endpoint, then fetch results. Flow: Queue → Poll status → Get results.

{
  "teamId": "a1b2c3d4-5678-9abc-def0-1234567890ab",
  "mode": "ranked"
}

{
  "battleId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "Queued",
  "queuedAt": "2026-02-11T14:30:00Z",
  "estimatedWaitSeconds": 12
}

Check the status of a battle.

Poll this endpoint to track your battle from queue to completion. Status progresses: Queued → InProgress → Completed.

Get detailed results of a completed battle.

Returns the full battle outcome: winner, turn count, a turn-by-turn combat log, and rewards earned. The battle log contains every action taken by every unit on every turn — perfect for analyzing your strategy's effectiveness.

Get your recent battle history.

Returns your past battles in reverse chronological order with pagination support.

Get the global leaderboard.

Returns the top players ranked by API (Arena Power Index) rating with win/loss statistics.

Get a specific player's ranking.

Look up any player's global rank, rating, and battle statistics.

Browse the strategy marketplace.

Explore community-created battle strategies. No authentication required. Sort options: "popular" (most downloaded), "rating" (highest rated), "newest" (most recent). Each strategy shows download count, average rating, win rate, and effectiveness multiplier.

GET /api/v1/strategies/browse?sortBy=rating&limit=5&offset=0

[
  {
    "strategyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Blitz Rush Alpha",
    "creatorName": "TacticalMind",
    "price": 150,
    "downloadCount": 342,
    "averageRating": 4.7,
    "winRate": 68.5,
    "effectivenessMultiplier": 1.15
  }
]

Publish a strategy to the marketplace.

Share your battle strategy with the community. Set a price in currency (0 for free). You earn currency each time another player purchases your strategy.

{
  "name": "Defensive Turtle",
  "description": "Tanky frontline with healer support",
  "strategyJson": "{\"formation\":\"defensive\",\"priority\":\"survive\"}",
  "price": 0
}

{
  "strategyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "Defensive Turtle",
  "description": "Tanky frontline with healer support",
  "price": 0,
  "createdAt": "2026-02-11T14:30:00Z"
}

Purchase and download a strategy.

Spend currency to acquire a marketplace strategy. The full strategy JSON is returned and can be used directly in your team configuration.

Rate a marketplace strategy.

Submit a 1-5 star rating with optional comment. You can only rate strategies you have downloaded.

Create a new guild.

Founds a new guild with you as the leader. Requires Premium tier or higher. Guild names and tags must be unique. Tags are automatically uppercased. You cannot create a guild if you're already in one.

{
  "name": "Shadow Wolves",
  "tag": "SWLF",
  "description": "Elite PvP guild focused on ranked battles"
}

{
  "guildId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Shadow Wolves",
  "tag": "SWLF",
  "description": "Elite PvP guild focused on ranked battles",
  "leaderName": "YourUsername",
  "level": 1,
  "memberCount": 1,
  "maxMembers": 20,
  "createdAt": "2026-02-11T14:00:00Z"
}

Delete your guild.

Permanently deletes the guild and removes all members. Only the guild leader can perform this action. This action is irreversible.

Get guild details.

Get your current guild.

Returns guild details for the guild you currently belong to.

List guild members.

Invite a player to your guild.

Send a guild invitation to another player by username. Requires Officer or Leader role. Invites expire after 7 days. The target player must not already be in a guild.

{
  "username": "EliteWarrior42"
}

{
  "inviteId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "guildId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "guildName": "Shadow Wolves",
  "guildTag": "SWLF",
  "invitedByUsername": "YourUsername",
  "status": "Pending",
  "createdAt": "2026-02-11T14:30:00Z",
  "expiresAt": "2026-02-18T14:30:00Z"
}

View your pending guild invites.

Accept a guild invite.

Decline a guild invite.

Kick a member from the guild.

Remove a player from your guild. Requires Leader role. You cannot kick members with equal or higher rank than yourself.

Promote or demote a guild member.

Change a member's role. Only the guild leader can promote/demote. Promoting to Leader transfers guild ownership — you become an Officer. Valid roles: Member, Officer, Leader.

{
  "playerId": "d4c3b2a1-8f7e-6d5c-4b3a-2e1f0a9b8c7d",
  "newRole": "Officer"
}

{
  "message": "Player promoted to Officer."
}

Leave your current guild.

Voluntarily leave the guild you belong to. Guild leaders cannot leave — transfer leadership first or delete the guild.

View guild treasury and available upgrades.

Shows the guild's gold balance, current upgrade levels, and what upgrades can be purchased.

Purchase a guild upgrade from the treasury.

Spend treasury gold on permanent guild upgrades. Only the guild leader can make purchases. Available upgrades: max_members_30, max_members_50, gold_bonus_10, gold_bonus_20, raid_attempts_4, raid_attempts_5.

{
  "upgradeId": "gold_bonus_10"
}

{
  "balance": 20000,
  "goldBonusPercent": 10,
  "maxRaidAttempts": 3,
  "maxMembers": 20
}

Deposit personal gold into the guild treasury.

Transfer gold from your personal balance to the guild treasury. This increases your contribution points. Any guild member can deposit.

Get guild chat messages.

Returns recent chat messages in chronological order. Supports cursor-based pagination using the `before` parameter to load older messages.

Post a message to guild chat.

Send a text message to your guild's chat channel. Messages are limited to 500 characters. You must be a member of the guild.

List guild strategies.

View all battle strategies shared in the guild library. Strategies are sorted by usage count.

Publish a strategy to the guild library.

Share a battle strategy with your guild. Requires Officer or Leader role.

Update a guild strategy.

Modify a strategy in the guild library. Only the original creator or the guild leader can update.

Delete a guild strategy.

Remove a strategy from the guild library. Only the original creator or guild leader can delete.

Get your guild's current boss encounter.

Returns the active raid boss including remaining HP, expiration time, and rewards. Bosses spawn periodically and must be defeated before they expire. You must be a member of a guild to access boss encounters.

{
  "bossId": "b0a1c2d3-e4f5-6789-0abc-def123456789",
  "name": "Shadow Dragon Kaelthos",
  "description": "A fearsome dragon that deals AoE fire damage",
  "maxHp": 50000,
  "currentHp": 32150,
  "expiresAt": "2026-02-12T18:00:00Z",
  "isDefeated": false,
  "rewardCurrency": 1000,
  "rewardExperience": 2500
}

Attack the guild boss with your team.

Send a team to damage the guild boss. Multiple guild members can attack the same boss — coordinate for maximum impact. If your attack delivers the killing blow, wasKillingBlow will be true and bonus rewards may be awarded.

{
  "bossId": "b0a1c2d3-e4f5-6789-0abc-def123456789",
  "teamId": "d4e5f6a7-b8c9-0123-4567-890abcdef012"
}

{
  "attemptId": "a1234567-b89c-def0-1234-567890abcdef",
  "damageDealt": 4250,
  "wasKillingBlow": false,
  "attemptedAt": "2026-02-11T15:22:00Z"
}

Get the boss damage leaderboard.

See which guild members dealt the most damage to a specific boss encounter.

Get your active daily challenges.

Returns your current set of daily challenges with progress tracking. New challenges generate every 24 hours. Complete them by playing battles that meet the criteria, then claim rewards before they expire.

[
  {
    "challengeId": "c9a1b2d3-4e5f-6789-abcd-ef0123456789",
    "name": "Win 3 Battles",
    "description": "Win 3 ranked battles today",
    "progress": 1,
    "requiredProgress": 3,
    "isCompleted": false,
    "rewardCurrency": 200,
    "rewardExperience": 500,
    "expiresAt": "2026-02-12T00:00:00Z"
  }
]

Claim a completed challenge reward.

Collect currency and experience for a completed challenge. The challenge must show isCompleted: true before you can claim. Each challenge can only be claimed once.

Refresh your daily challenges (Premium only).

Replaces all uncompleted challenges with a fresh set. Premium and Premium Plus subscribers can refresh once per day. Already-completed challenges are kept. Each refresh generates one easy, one medium, and one hard challenge — giving you a better shot at rewards that match your skill level.

Get mastery levels for all your units.

Returns mastery progression for every unit you have used in battle. Mastery increases with use — tracks battles fought, wins, and win rate per unit.

[
  {
    "unitId": "u1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "level": 5,
    "experiencePoints": 2450,
    "battlesUsed": 47,
    "winsWithUnit": 31
  },
  {
    "unitId": "u9f8e7d6-c5b4-3210-fedc-ba0987654321",
    "level": 3,
    "experiencePoints": 1100,
    "battlesUsed": 22,
    "winsWithUnit": 12
  }
]

Get mastery for a specific unit.

Returns detailed mastery data for one unit. If you have never used the unit in battle, returns a default record with Level 1 and zero experience.

Get the active environmental modifier.

Environmental modifiers rotate weekly and change the rules of battle for everyone. No authentication required. Check this before every battle to adapt your strategy. Returns a "Normal" placeholder when no modifier is active.

{
  "modifierId": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "name": "Arcane Surge",
  "description": "Magic damage increased by 25% for all units",
  "startDate": "2026-02-10T00:00:00Z",
  "endDate": "2026-02-17T00:00:00Z"
}

Preview next week's modifier.

See what environmental effect is coming next. Use this intel to prepare your team and strategy ahead of the rotation. Not always available.

Create a shareable battle replay.

Generate a shareable link for a completed battle. The replay can be viewed by anyone with the link, even without an account. You must be a participant in the battle.

{
  "battleId": "b7e8f9a0-1234-5678-9abc-def012345678"
}

{
  "replayId": "r1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "battleId": "b7e8f9a0-1234-5678-9abc-def012345678",
  "shareUrl": "xK9mPq2v",
  "viewCount": 0,
  "createdAt": "2026-02-11T16:45:00Z"
}

View a battle replay.

Retrieve a battle replay by its share URL. No authentication required — anyone can view shared replays. Each view increments the replay's view counter.

List all available AI opponents.

Returns AI opponents across three difficulty tiers: novice, intermediate, and expert. Each opponent has a fixed team composition and strategy. Practice battles award 50% of normal gold and XP, never affect your API rating, and don't count against your daily battle limit. Use AI opponents to learn the combat system, test new team compositions, or experiment with strategy configurations before risking your rating in ranked matches.

{
  "opponents": [
    {
      "id": "novice-1",
      "name": "Training Dummy",
      "difficulty": "novice",
      "approximateRating": 600,
      "teamSize": 3,
      "teamClasses": ["Warrior", "Ranger", "Mage"],
      "formation": "balanced"
    }
  ],
  "rewardMultiplier": 0.5,
  "ratingAffected": false,
  "countsTowardDailyLimit": false
}

Fight an AI opponent in a practice battle.

Instantly resolves a battle between your team and the selected AI opponent — no matchmaking queue or waiting. The full turn-by-turn combat log is returned immediately. **Rewards**: 50% of normal gold and XP. No rating change. No daily limit consumed. **Strategy**: Your team's strategy configuration is used exactly as configured. The AI uses a fixed strategy appropriate to its difficulty level. This makes practice battles ideal for A/B testing strategy changes — fight the same AI opponent with different configs and compare results.

{
  "teamId": "a1b2c3d4-5678-9abc-def0-1234567890ab",
  "opponentId": "novice-1"
}

{
  "battleId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "completed",
  "winnerId": "your-player-id",
  "turns": 8,
  "battleLog": [...],
  "rewards": {
    "currency": 25,
    "ratingChange": 0,
    "experienceEarned": 50,
    "tierMultiplier": 1.0
  }
}

Get the current ranked season and your progress.

Returns the active season details along with your current tier, rating, win/loss record, and progress toward the next tier. Seasons last 8 weeks. At the end of each season, your rating soft-resets and you earn rewards based on your peak tier. **Tier Thresholds**: Bronze (0) → Silver (1000) → Gold (1200) → Platinum (1400) → Diamond (1600) → Legend (1800) If no season exists, one is automatically created when you first call this endpoint.

{
  "seasonId": "...",
  "name": "Season 1: Dawn of Battle",
  "seasonNumber": 1,
  "daysRemaining": 42,
  "currentTier": "Silver",
  "seasonRating": 1050,
  "peakRating": 1120,
  "peakTier": "Gold",
  "wins": 15,
  "losses": 8,
  "winRate": 65.2,
  "ratingToNextTier": 150,
  "nextTier": "Gold"
}

Get the season leaderboard.

Returns ranked players ordered by season rating. Only players with at least one ranked battle this season appear on the leaderboard. Your own rank is included in the response.

Claim end-of-season rewards.

After a season ends, claim your rewards based on your peak tier. Rewards include gold, XP, and exclusive titles for Gold tier and above. Rewards can only be claimed once per season. **Rewards by Peak Tier**: - Bronze: 100g + 50 XP - Silver: 250g + 100 XP - Gold: 500g + 200 XP + "Gold Gladiator" title - Platinum: 1,000g + 400 XP + "Platinum Warrior" title - Diamond: 2,000g + 800 XP + "Diamond Champion" title - Legend: 5,000g + 1,500 XP + "Legendary Conqueror" title

{
  "seasonName": "Season 1: Dawn of Battle",
  "peakTier": "Gold",
  "goldReward": 500,
  "xpReward": 200,
  "exclusiveTitle": "Gold Gladiator",
  "claimed": true
}

Get your unclaimed loot drops.

After each battle, you have a chance to receive random loot drops. Base drop chance is 15%, increasing with win streaks (up to 25% at 3+ wins). Premium players get a guaranteed drop every 5 battles. **Drop Types**: - **CurrencyPack**: Random gold (50-800g) - **XpBoost**: Bonus XP (50-200) - **CriticalGold**: JACKPOT! 3x your base battle reward (5% chance, independent roll) - **RareTitle**: An exclusive display title (5% of drops) Drops accumulate until claimed. Use POST /api/v1/loot/claim to collect everything at once.

Claim all pending loot drops.

Claims all unclaimed loot drops, awarding gold, XP, and any titles earned. Returns a summary of everything claimed.

{
  "goldAwarded": 750,
  "xpAwarded": 150,
  "titlesUnlocked": ["Lucky Strike"],
  "dropsClaimed": 4
}

Get your referral code and stats.

Returns your unique referral code and how many players have signed up using it. Share your code with friends — when they redeem it, you both get rewarded: - **You (referrer)**: +500g per successful referral - **Them (new player)**: +300g bonus starting currency A new code is automatically generated each time one is redeemed, so you can always share your latest code.

{
  "referralCode": "ABCD1234",
  "totalReferrals": 3,
  "totalGoldEarned": 1500,
  "rewardPerReferral": 500,
  "referredPlayerBonus": 300
}

Redeem a referral code.

Redeem a friend's referral code to receive a 300g bonus. You can only redeem one referral code per account, and you cannot use your own code.

{
  "success": true,
  "bonusGoldAwarded": 300,
  "referrerUsername": "FriendlyPlayer"
}

View the referral leaderboard.

See who has referred the most players. Top referrers are driving community growth.

Rename a unit you own.

Give your unit a custom display name. Costs 200g. The original name is preserved internally — your custom name appears in battle logs and your roster. Names must be 3-50 characters. No profanity filter (yet — be nice).

{
  "unitId": "...",
  "newName": "Thunderstrike"
}

{
  "unitId": "...",
  "name": "Bronze Knight",
  "customName": "Thunderstrike",
  "goldSpent": 200,
  "remainingCurrency": 800
}

Reroll a unit's stats.

Randomizes one stat within the unit's class range. Costs 500g per reroll. The stat chosen and new value are random — you might get a better roll or a worse one. Each subsequent reroll on the same unit costs 500g. **Stat ranges vary by class** — Warriors have higher base health, Mages have higher attack, etc. The reroll respects these class boundaries.

Apply golden upgrade to a unit.

Permanently boosts ALL stats by 5%. Costs 2000g and can only be applied once per unit. Golden units get a special designation visible in battle logs and your roster. This is the ultimate investment — make sure you're upgrading a unit you'll keep in your main team long-term.

{
  "unitId": "..."
}

{
  "unitId": "...",
  "name": "Archmage",
  "isGolden": true,
  "health": 105,
  "attack": 47,
  "defense": 15,
  "speed": 21,
  "goldSpent": 2000,
  "remainingCurrency": 3000
}

Get your current rival.

Every player is automatically assigned a rival — someone at a similar rating level. Rivals rotate weekly. When you beat your rival in a ranked battle, you earn a +100g bonus on top of normal rewards. The rival system creates a personal nemesis to drive competitive motivation. Track your head-to-head record and prove you're the better player.

{
  "rivalId": "...",
  "rivalUsername": "ShadowBlade42",
  "rivalRating": 1050,
  "rivalLevel": 5,
  "winsAgainstRival": 2,
  "lossesAgainstRival": 1,
  "bonusGoldEarned": 200,
  "bonusPerWin": 100,
  "hasRival": true
}

Get your current battle pass progress.

Returns your current level, XP progress, and all rewards (claimed and unclaimed). Each season has a 30-level battle pass. Free-track rewards are available to everyone. Premium-track rewards unlock with Premium Plus subscription. XP sources: battles (+100 win / +25 loss), daily challenges (+50-200), daily login (+25). Premium Plus players earn 25% bonus battle pass XP.

{
  "passName": "Season 1 Battle Pass",
  "currentLevel": 12,
  "currentXp": 450,
  "xpToNextLevel": 550,
  "maxLevel": 30,
  "overallProgressPercent": 41.5,
  "hasPremium": false,
  "rewards": [...],
  "daysRemaining": 34
}

Claim a battle pass level reward.

Claims the reward at the specified level. You must have reached that level to claim. Free-track rewards are available to all players. Premium-track rewards require Premium Plus subscription. Each level has both a free and premium reward. Claiming checks free first, then premium. Rewards are granted immediately — currency goes to your balance, XP to your profile, titles to your collection.

{
  "success": true,
  "level": 5,
  "track": "free",
  "rewardType": "currency",
  "rewardValue": 275,
  "description": "Level 5 Milestone: 250g",
  "message": "Claimed Level 5 Milestone: 250g!"
}

Get your guild's current war status.

Shows your guild's active war matchup, including scores, opponent info, and top contributors. Wars are matched weekly between guilds of similar level. Every ranked battle win during a war earns 10 points for your guild. The winning guild gets a treasury bonus at the end of the week. In a draw, the reward is split.

{
  "isAtWar": true,
  "warId": "...",
  "yourGuild": "Shadow Legion",
  "yourScore": 150,
  "opponentGuild": "Storm Riders",
  "opponentScore": 120,
  "daysRemaining": 4,
  "treasuryReward": 750,
  "topContributors": [...]
}

Get your guild's war history.

Returns past guild wars with results. Track your guild's competitive record and see how much treasury gold you've earned from victories.

Get the current or most recent tournament.

Returns tournament info including registration status, participants, prize pool, and your entry status. Tournaments run weekly: registration opens, then brackets are generated and matches play out automatically. Entry fee is 100g. Top 4 finishers win prizes (1st: 5000g + title, 2nd: 2500g, 3rd/4th: 1000g). Brackets are seeded by API rating — higher rated players face lower seeds first.

{
  "tournamentId": "...",
  "name": "Weekly Tournament #20260212",
  "status": "registration",
  "maxParticipants": 16,
  "currentParticipants": 7,
  "entryFee": 100,
  "prizes": [...],
  "isRegistered": false
}

Enter the current tournament.

Register for the active tournament with your team. Costs the entry fee (100g). You can only enter once per tournament. Registration closes when the tournament starts or when max participants is reached.

View a tournament bracket.

Returns the full bracket with match results for each round. Shows all matchups, who won, and who's advancing. Use this to track the tournament's progress.

Browse the cosmetic shop.

Shows all available cosmetics with prices in gems and gold. Includes your current balance and whether you already own each item. Categories: unit_skin, profile_border, card_back, battle_effect. Rarities: common, rare, epic, legendary (legendary items are gems-only). Gems are earned from tournaments, battle pass milestones, and special events.

View your owned cosmetics.

Purchase a cosmetic item.

Buy a cosmetic from the shop using gems or gold. Each item shows available payment options — legendary items are gems-only (goldPrice = 0).

Equip a cosmetic item.

Set a cosmetic as active. Only one cosmetic per category can be equipped at a time. Equipping a new profile_border unequips the previous one automatically.

Check your gem and gold balance.

View all perks for your current subscription tier.

Returns a complete breakdown of every benefit your subscription tier provides, including multipliers, limits, and exclusive features. Free players can see what they're missing — use this to decide if upgrading is worth it.

{
  "currentTier": "PremiumPlus",
  "goldMultiplier": 2.0,
  "xpMultiplier": 1.5,
  "battlePassXpBonus": 0.25,
  "dailyBattleLimit": -1,
  "maxTeamSlots": 10,
  "canCreateGuild": true,
  "canRefreshChallenges": true,
  "guaranteedLootEveryNBattles": 3,
  "hasPremiumBattlePassTrack": true,
  "monthlyGemStipend": 500,
  "hasCreatorBadge": true,
  "hasExclusiveCosmetics": true,
  "lootRarityBoost": 0.15,
  "badge": "creator"
}

Claim your monthly gem stipend (Premium Plus only).

Premium Plus subscribers receive 500 free gems every 30 days. Claim them here. The timer resets from your last claim date, not the calendar month.

Set your profile badge.

Equip a badge that displays on your profile. Different tiers unlock different badges. Premium Plus members get exclusive badges like "creator", "elite", and "vip". Send null to remove your badge.

{ "badge": "creator" }

List badges available for your tier.

See which badges you can equip based on your subscription tier. Upgrading to Premium Plus unlocks exclusive badges.

Get your activity feed.

Returns a chronological feed of your recent game activities — battles fought, achievements unlocked, level-ups, and more. Paginated for easy consumption.

Get another player's public activity feed.

View the public activity feed for any player by username. Only public activities are shown — private events are hidden.

Get your lifetime stats (sunk cost profile).

A comprehensive breakdown of everything you've invested in the game: total battles, gold earned, win rate, achievements, time played, and more. See the full picture of your gaming journey.

{
  "username": "DragonSlayer",
  "level": 42,
  "rating": 1850,
  "totalBattlesPlayed": 347,
  "totalBattlesWon": 198,
  "winRate": 57.1,
  "highestRating": 1923,
  "totalGoldEarned": 125000,
  "achievementsUnlocked": 28,
  "daysPlayed": 65,
  "investmentSummary": "347 battles fought | 125,000g earned | reached level 42 | playing for 65 days"
}

Get another player's public lifetime stats.

View the lifetime stats for any player by username. Compare your progress against rivals and friends.

Browse published curriculum modules.

Lists all published educational modules, sorted by popularity. Each module teaches API concepts through guided game challenges — from basic REST to advanced strategies.

Create a curriculum module (instructor).

Any player can create educational modules. Define lessons that guide students through specific API endpoints. The module starts as unpublished — publish it when you're ready for students to enroll.

{
  "title": "API Basics 101",
  "description": "Learn REST fundamentals through combat",
  "difficulty": "beginner",
  "lessons": [
    { "title": "Register", "objective": "Create your first account", "endpoint": "POST /api/v1/auth/register", "hint": "Use a unique username and valid email" },
    { "title": "Login", "objective": "Get your JWT token", "endpoint": "POST /api/v1/auth/login", "hint": "Save the token for future requests" }
  ]
}

Get detailed module info and your progress.

Publish a module for public access.

Enroll in a module.

Enroll using a join code.

Mark a lesson as complete.

Get your enrolled modules and progress.

Instructor dashboard with student analytics.

View stats for all modules you've created: enrollment counts, completion rates, and average student progress. Use this data to improve your curriculum.

Quick-start guide for new API consumers.

Returns a structured quick-start guide with step-by-step instructions, authentication details, and example code snippets in multiple languages. Use this to bootstrap your client application.

Full endpoint catalog organized by category.

Lists all available API endpoints grouped by feature category. Use this to discover endpoints and plan your client integration.

Game status and public metrics.

Returns server health status and public game metrics — total players, active seasons, running tournaments, and completed battles. Useful for monitoring dashboards and bot status checks.

Link your Discord account.

Initiates the Discord linking process. You'll receive a 6-digit verification code. Use the verify endpoint with this code to complete the link. Once linked, Discord bots can look up your game profile and send notifications.

Get your Discord link status.

Unlink your Discord account.

Verify Discord link with code.

Register a webhook for game event notifications.

Register a Discord webhook URL to receive game events (battle results, level-ups, etc.). Maximum 5 webhooks per player. Specify which event types you want to receive.

{
  "webhookUrl": "https://discord.com/api/webhooks/...",
  "label": "Battle Alerts",
  "eventTypes": ["battle_won", "battle_lost", "level_up"]
}

List your registered webhooks.

Look up a player by Discord user ID (for bots).

Discord bots can use this endpoint to look up a player's game profile by their Discord user ID. Only returns data for verified links.

Apply to become a content creator.

Submit your application to join the content creator program. Once verified by admins, you'll earn gems from strategy downloads, get a "creator" badge, and be eligible for the monthly spotlight.

{
  "creatorName": "StrategyKing",
  "bio": "I create advanced team compositions and publish educational guides."
}

Get your creator profile.

Get your detailed creator stats.

View your content performance: strategy download counts, ratings, educational module enrollments, and gem earnings.

Browse verified content creators.

Lists all verified creators, sorted by total downloads. Verified creators have been reviewed and approved by admins.

Get this month's creator spotlight.

View the featured creators for the current month. Spotlighted creators are selected based on content quality, download volume, and community impact.