Public by default. Endpoints with Auth = yes need a bearer token.
Header: Authorization: Bearer <token> — obtain via /api/auth/discord.
- Responses are JSON
- Filtering via query params (
?limit=20&offset=0) - Rate limiting may apply
cards
Access card data, search cards, view detailed information, awakening trees, and upload card assets.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/cards |
Get all cards with optional filtering. Supports query parameters: name, rarity, type, category, limit, offset. | no | |
| GET | /api/cards/:id |
Get detailed information about a specific card by ID, including stats, passive skills, super attack, and links. | no | |
| GET | /api/cards/:id/awakenings |
Get the complete awakening tree for a card, showing all possible evolution paths and required materials. | no |
categories
Browse and filter cards by categories, tags, and classifications used in Dokkan Battle.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/categories |
Get all available card categories (e.g., "Pure Saiyans", "Realm of Gods", "Final Trump Card", etc.). | no | |
| GET | /api/categories/:id |
Get detailed information about a specific category, including all cards that belong to it. | no |
users
Access user profiles, collections, teams, and server summaries. Some endpoints require authentication.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/users |
Get a list of all users with optional filtering and pagination. Supports query parameters: limit, offset, search. | no | |
| GET | /api/users/:id |
Get detailed user profile information including rank, EXP, level, and basic statistics. | no | |
| GET | /api/users/me |
Get the authenticated user's own profile information. Requires JWT token in Authorization header. | yes | |
| GET | /api/users/me/servers-summary |
Get a summary of all Discord servers where the authenticated user has accounts, including server stats. | yes | |
| GET | /api/users/:userId/collection-summary |
Get a summary of a user's card collection including total cards, rarity breakdown, and collection statistics. | no | |
| GET | /api/users/:userId/collection |
Get a user's complete card collection with details about each card they own. | no | |
| GET | /api/users/:userId/:serverId/auto-team |
Generate an optimized team composition for a user in a specific server based on their collection and leader skills. | no | |
| PUT | /api/users/me/favorite-card |
Update the authenticated user's favorite card. Requires JWT token and card ID in request body. | yes |
bosses
Access boss event information, rewards, and server-specific boss configurations.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/bosses |
Get all boss events with optional filtering. Returns boss cards, HP, DEF, and event information. | no | |
| GET | /api/bosses/servers |
Get a list of all unique Discord server IDs that have boss events configured. | no | |
| GET | /api/bosses/:id |
Get detailed information about a specific boss event including stats, duration, and configuration. | no | |
| GET | /api/bosses/:id/rewards |
Get rewards for a boss event, including participant rewards and non-participant rewards. | no | |
| POST | /api/bosses |
Create a new boss event. Requires authentication and boss configuration in request body. | yes | |
| PUT | /api/bosses/:id |
Update an existing boss event. Requires authentication and updated configuration in request body. | yes | |
| POST | /api/bosses/:id/duplicate |
Duplicate a boss event to another server. Requires authentication and serverId in request body. | yes |
events
Access event data, rewards, and event-related information from Dokkan Battle.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/events |
Get all events with optional filtering. Returns event information, dates, and descriptions. | no | |
| GET | /api/events/:id |
Get detailed information about a specific event including full description and requirements. | no | |
| GET | /api/events/:id/rewards |
Get all rewards available from a specific event, including items, cards, and other rewards. | no |
items
Access item information including descriptions, effects, and usage in the game.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/items |
Get all items available in Dokkan Battle with optional filtering and pagination. | no | |
| GET | /api/items/:id |
Get detailed information about a specific item including description, effects, and how to obtain it. | no |
missions
Access mission data, requirements, and mission-related information.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/missions |
Get all missions with optional filtering. Returns mission objectives and requirements. | no | |
| GET | /api/missions/:id |
Get detailed information about a specific mission including objectives, rewards, and completion criteria. | no |
leaderboards
Access global and server-specific leaderboards showing top players.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/leaderboards |
Get top users ranked by EXP. Supports query parameter: limit (default: 10) to control how many results to return. | no |
stats
Access global statistics and dashboard data for the Dokkan Simulator platform.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/stats/global |
Get global statistics including total users, cards, events, and platform-wide metrics. | no | |
| GET | /api/stats/dashboard |
Get dashboard statistics for admin panels, including user growth, activity metrics, and system health. | no |
download
Download card assets and user collections as ZIP files.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| POST | /api/download/cards |
Download card assets (images, thumbnails, backgrounds) for multiple cards. Send cardIds array in request body. Returns a ZIP file. | no | |
| GET | /api/download/user/:userId |
Download a user's complete collection as a ZIP file containing all their card assets. | no |
discord
Access Discord user information and avatar URLs.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/discord/users/:userId |
Get Discord user information by user ID. Returns username, avatar, discriminator, and other Discord profile data. Supports query parameter: size for avatar size. | no | |
| GET | /api/discord/avatar |
Get Discord avatar URL for a user. Requires query parameters: userId and optional size (default: 256). | no |
medals
Access medal data, images, and upload medal assets. Some endpoints require API key authentication.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/medals |
Get all medals from the database with their information and properties. | no | |
| GET | /api/medals/:id |
Get detailed information about a specific medal by ID, including its properties and effects. | no | |
| GET | /api/medals/images |
Get a list of all medal image files available. Supports query parameter: search to filter by filename. | no | |
| GET | /api/medals/:medalId |
Get medal image information by medal ID, including filename and direct URL to the image. | no |
towers
Access tower event information, rewards, and server-specific tower configurations.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/towers |
Get all tower events with optional filtering and pagination. Returns tower information including steps, power, and rewards. | no | |
| GET | /api/towers/servers |
Get a list of all unique Discord server IDs that have tower events configured. | no | |
| GET | /api/towers/:id |
Get detailed information about a specific tower event including configuration, steps, and power scaling. | no | |
| GET | /api/towers/:id/rewards |
Get all rewards for a tower event grouped by step. Shows what rewards players receive at each floor. | no |
auth
Discord OAuth2 authentication endpoints. These handle user login and session management.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/auth/discord |
Initiate Discord OAuth2 authentication flow. Redirects user to Discord for authorization. | no | |
| GET | /api/auth/discord/callback |
Discord OAuth2 callback endpoint. Handles the redirect from Discord after user authorization. Returns JWT token for authenticated requests. | no | |
| GET | /api/auth/me |
Get the authenticated user's Discord profile information. Requires JWT token in Authorization header. | yes | |
| GET | /api/auth/me/guilds |
Get a list of Discord servers (guilds) where the authenticated user has administrative permissions. Used for server management access. | yes |
server
Server management endpoints for Discord server administrators. All endpoints require authentication and server ownership verification.
| Method | Path | Description | Auth | |
|---|---|---|---|---|
| GET | /api/server/:serverId/summons |
Get all summon banners configured for a Discord server. Returns banner list with their configurations. | yes | |
| POST | /api/server/:serverId/summons |
Create a new summon banner for a Discord server. Requires banner configuration in request body. | yes | |
| PUT | /api/server/:serverId/summons/:id |
Update an existing summon banner configuration. Requires updated banner data in request body. | yes | |
| DELETE | /api/server/:serverId/summons/:id |
Delete a summon banner from a Discord server. | yes | |
| GET | /api/server/:serverId/summons/:id/featured |
Get featured cards for a specific summon banner. | yes | |
| POST | /api/server/:serverId/summons/:id/featured |
Add a featured card to a summon banner. Requires cardId in request body. | yes | |
| DELETE | /api/server/:serverId/summons/:id/featured/:cardId |
Remove a featured card from a summon banner. | yes | |
| GET | /api/server/:serverId/summons/:id/steps |
Get step configuration for a summon banner (multi-step summons with different rates per step). | yes | |
| POST | /api/server/:serverId/summons/:id/steps |
Save step configuration for a summon banner. Requires step data array in request body. | yes | |
| GET | /api/server/:serverId/summons/:id/rates |
Get summon rates configuration for a banner (probability rates for each rarity tier). | yes | |
| POST | /api/server/:serverId/summons/:id/rates |
Save summon rates configuration for a banner. Requires rates object in request body. | yes | |
| POST | /api/server/:serverId/summons/import |
Import a summon banner configuration from JSON. Accepts full banner config in request body. | yes | |
| GET | /api/server/:serverId/boss-events |
Get all boss events configured for a Discord server. | yes | |
| POST | /api/server/:serverId/boss-events |
Create a new boss event for a Discord server. Requires boss event configuration in request body. | yes | |
| PUT | /api/server/:serverId/boss-events/:id |
Update an existing boss event configuration. | yes | |
| DELETE | /api/server/:serverId/boss-events/:id |
Delete a boss event from a Discord server. | yes | |
| GET | /api/server/:serverId/boss-events/:id/participants |
Get list of participants and their contributions for a boss event. | yes | |
| GET | /api/server/:serverId/boss-events/:id/attacks |
Get attack history for a boss event, showing all player attacks. | yes | |
| GET | /api/server/:serverId/boss-events/:id/rewards |
Get reward configuration for a boss event. | yes | |
| POST | /api/server/:serverId/boss-events/:id/rewards |
Save reward configuration for a boss event. Requires rewards array in request body. | yes | |
| GET | /api/server/:serverId/users |
Get all users in a Discord server with optional filtering and pagination. | yes | |
| GET | /api/server/:serverId/users/:userId |
Get detailed information about a specific user in a Discord server. | yes | |
| GET | /api/server/:serverId/users/:userId/inventory |
Get a user's inventory (items, cards, currency) in a specific server. | yes | |
| POST | /api/server/:serverId/users/:userId/inventory |
Modify a user's inventory (add/remove items, cards, or currency). Requires modification data in request body. | yes | |
| PUT | /api/server/:serverId/users/inventory/bulk |
Perform bulk inventory operations on multiple users. Requires operation data in request body. | yes | |
| POST | /api/server/:serverId/users/:userId/gift |
Send a gift (items, cards, currency) to a user. Requires gift data in request body. | yes | |
| GET | /api/server/:serverId/stats/overview |
Get server statistics overview including user count, activity, and key metrics. | yes | |
| GET | /api/server/:serverId/stats/rankings |
Get server-specific leaderboards and rankings. | yes | |
| GET | /api/server/:serverId/stats/summons |
Get summon statistics for a server including total summons, rates, and popular banners. | yes | |
| GET | /api/server/:serverId/stats/boss-events |
Get boss event statistics including participation rates and completion times. | yes | |
| GET | /api/server/:serverId/stats/economy |
Get economy statistics including currency distribution and item circulation. | yes | |
| POST | /api/server/:serverId/gifts/send-to-all |
Send a gift to all users in a server. Requires gift data in request body. | yes | |
| GET | /api/server/:serverId/towers |
Get all tower events configured for a Discord server. | yes | |
| POST | /api/server/:serverId/towers |
Create a new tower event for a Discord server. Requires tower configuration in request body. | yes | |
| PUT | /api/server/:serverId/towers/:id |
Update an existing tower event configuration. | yes | |
| DELETE | /api/server/:serverId/towers/:id |
Delete a tower event from a Discord server. | yes | |
| POST | /api/server/:serverId/towers/import |
Import a tower event configuration from JSON. Accepts full tower config in request body. | yes | |
| GET | /api/server/:serverId/daily-rewards |
Get daily reward configuration for a Discord server. Returns rewards for each day of the week. | yes | |
| POST | /api/server/:serverId/daily-rewards |
Create or update daily reward configuration. Requires reward data in request body. | yes | |
| PUT | /api/server/:serverId/daily-rewards/:day |
Update daily reward for a specific day (1-7). Requires reward data in request body. | yes | |
| DELETE | /api/server/:serverId/daily-rewards/:day |
Delete daily reward configuration for a specific day. | yes | |
| POST | /api/server/:serverId/daily-rewards/reset |
Reset daily rewards to default configuration. | yes | |
| GET | /api/server/:serverId/daily-rewards/default |
Get default daily reward configuration template. | yes |
fetch('https://api.dokkan-simulator.com/api/cards')
.then(r => r.json())
.then(console.log)
fetch('https://api.dokkan-simulator.com/api/cards/12345')
.then(r => r.json())
.then(console.log)
fetch('https://api.dokkan-simulator.com/api/users/me', {
headers: { Authorization: 'Bearer TOKEN' }
})
.then(r => r.json())
.then(console.log)