Deadlock API

Deprecated: Use /v2/patches instead, which returns a unified feed combining the Forum changelog and the Steam news feed.

Returns the parsed result of the RSS Feed from the official Forum.

RSS-Feed: https://forums.playdeadlock.com/forums/changelog.10/index.rss

Returns Patch[]

• author string
• category PatchCategory
• content_encoded string
• dc_creator string
• guid PatchGuid
• link string
• pub_date string
• slash_comments string
• title string

curl "https://api.deadlock-api.com/v1/patches"

Returns a list of dates where Deadlock's "big" patch days were, usually bi-weekly. The exact date is the time when the announcement forum post was published.

This list is manually maintained, and so new patch dates may be delayed by a few hours.

Returns string[]

curl "https://api.deadlock-api.com/v1/patches/big-days"

Returns a unified feed combining patch notes from the official Forum changelog and the Steam news feed.

Each entry is tagged with a source field (forum or steam).

• Forum RSS: https://forums.playdeadlock.com/forums/changelog.10/index.rss
• Steam News RSS: https://store.steampowered.com/feeds/news/app/1422450/

Returns FeedItem[]

curl "https://api.deadlock-api.com/v2/patches"

Returns active matches that are currently being played.

Fetched from the watch tab in game, which is limited to the top 200 matches.

Returns ActiveMatch[]

• compat_version? int32
• duration_s? int32
• game_mode? int32
• game_mode_parsed? ActiveMatchGameMode
• game_mode_version? int32
• lobby_id? int64
• match_id? int64
• match_mode? int32
• match_mode_parsed? ActiveMatchMode
• match_score? int32
• net_worth_team_0? int32
• net_worth_team_1? int32
• objectives_mask_team0? int64
• objectives_mask_team1? int64
• open_spectator_slots? int32
• players ActiveMatchPlayer[]
• region_mode? int32
• region_mode_parsed? RegionMode
• spectators? int32
• start_time? int32
• winning_team? int32
• winning_team_parsed? ActiveMatchTeam

curl "https://api.deadlock-api.com/v1/matches/active"

Returns active matches that are currently being played, serialized as protobuf message.

Fetched from the watch tab in game, which is limited to the top 200 matches.

You have to decode the protobuf message.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Message:

• CMsgClientToGcGetActiveMatchesResponse

Returns int32[]

curl "https://api.deadlock-api.com/v1/matches/active/raw"

Returns a list of all currently available live broadcast URLs.

These can be used in any demofile broadcast parser:

• Demofile-Net
• Haste

Returns LiveUrl[]

• broadcast_url string
• lobby_id? int64
• match_id int64
• started_at? int64
• updated_at? int64

curl "https://api.deadlock-api.com/v1/matches/live/urls"

Submit one or more live broadcast URLs so they show up in the GET /live/urls listing.

Each submitted URL is stored for 15 minutes; re-submit periodically to keep a match listed while it is still live. Existing entries for the same match_id are overwritten.

These URLs can be used in any demofile broadcast parser:

• Demofile-Net
• Haste

curl -X POST "https://api.deadlock-api.com/v1/matches/live/urls"

This endpoints lets you fetch multiple match metadata at once. The response is a JSON array of match metadata.

When player info is included, each player object contains a hero_build_id field (if available) from demo analysis.

> Note: The hero_build_id represents the first build the player had selected when the game started. It does not reflect any build changes made during the match.

Returns int32[]

curl "https://api.deadlock-api.com/v1/matches/metadata"

This endpoint returns a list of match ids that have been fetched within the last 10 minutes.

Returns ClickhouseMatchInfo[]

• average_badge? int32
• average_badge_team0? int32
• average_badge_team1? int32
• duration_s int32
• game_mode int32
• match_id int64
• match_mode int32
• players MatchPlayer[]
• start_time int32

curl "https://api.deadlock-api.com/v1/matches/recently-fetched"

This endpoints spectates a match and returns the live URL to be used in any demofile broadcast parser.

Example Parsers:

• Demofile-Net
• Haste

Returns MatchSpectateResponse

• broadcast_url string
• lobby_id? int64

curl "https://api.deadlock-api.com/v1/matches/{match_id}/live/url"

This endpoint returns the match metadata for the given match_id parsed into JSON.

Each player object is enriched with a hero_build_id field (if available) from demo analysis.

> Note: The hero_build_id represents the first build the player had selected when the game started. It does not reflect any build changes made during the match.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Messages:

• CMsgMatchMetaData
• CMsgMatchMetaDataContents

curl "https://api.deadlock-api.com/v1/matches/{match_id}/metadata"

This endpoints returns the raw .meta.bz2 file for the given match_id.

You have to decompress it and decode the protobuf message.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Messages:

• CMsgMatchMetaData
• CMsgMatchMetaDataContents

Returns int32[]

curl "https://api.deadlock-api.com/v1/matches/{match_id}/metadata/raw"

This endpoints returns salts that can be used to fetch metadata and demofile for a match.

Note: We currently fetch many matches without salts, so for these matches we do not have salts stored.

Returns MatchSaltsResponse

• cluster_id? int32
• demo_url? string
• match_id int64
• metadata_salt? int32
• metadata_url? string
• replay_salt? int32

curl "https://api.deadlock-api.com/v1/matches/{match_id}/salts"

This endpoint creates a custom match using a bot account.

Process: 1. A party is created with your provided settings. 2. The system waits for the party code to be generated. 3. The party code is returned in the response. 4. The bot switches to spectator mode. 5. The bot marks itself as ready. 6. You and other players join, ready up, and start the match.

Callbacks: If a callback URL is provided, POST requests will be sent to it:

• settings: When lobby settings change, a POST is sent to {callback_url}/settings with the CsoCitadelParty protobuf message as JSON.
• match start: When the match starts, a POST is sent to {callback_url} with the match ID.

_Protobuf definitions: https://github.com/SteamDatabase/Protobufs_

Note: The bot will leave the match 15 minutes after creation, regardless of match state.

Returns CreateCustomResponse

• callback_secret? string
• party_code string
• party_id string

curl -X POST "https://api.deadlock-api.com/v1/matches/custom/create"

This endpoint makes the bot leave the custom match lobby early. By default the bot leaves automatically after 15 minutes, but this endpoint allows you to trigger it sooner.

curl -X POST "https://api.deadlock-api.com/v1/matches/custom/{lobby_id}/leave"

This endpoint allows you to ready up for a custom match.

curl -X POST "https://api.deadlock-api.com/v1/matches/custom/{lobby_id}/ready"

This endpoint starts a custom match.

curl -X POST "https://api.deadlock-api.com/v1/matches/custom/{lobby_id}/start"

This endpoint allows you to unready for a custom match.

curl -X POST "https://api.deadlock-api.com/v1/matches/custom/{lobby_id}/unready"

This endpoint allows you to get the match id of a custom match.

Returns GetCustomMatchIdResponse

• match_id int64

curl "https://api.deadlock-api.com/v1/matches/custom/{party_id}/match-id"

Run a SQL query over a match's live broadcast and stream result rows over Server-Sent Events as the match plays, instead of waiting for the demo to finish (see the async /demo/query).

Provide either match_id (the server spectates the lobby to obtain the broadcast URL) or an explicit broadcast_url from /live/urls.

Projection/filter queries emit rows continuously as they are decoded. A whole-match aggregation (GROUP BY / ORDER BY) can only produce its final rows once the broadcast ends.

curl "https://api.deadlock-api.com/v1/matches/demo/live/query?query=<query>"

Submit a SQL query against a match's demo file. The work (download + decompress + parse + query) takes ~55s, so this is asynchronous: the endpoint returns a job_id you poll via /demo/query/{job_id}. Once done, the status response carries a public URL to the result artifact (Parquet or NDJSON).

Identical (match_id, query, format) submissions are deduplicated and reuse a cached result.

Returns DemoQueryJobResponse

• job_id string
• status JobStatus

curl -X POST "https://api.deadlock-api.com/v1/matches/demo/query"

Returns the status of a demo query job. While queued/running it includes a rough estimated_wait_seconds; when done it includes result_url (a public link to the Parquet artifact, or the zstd-compressed .ndjson.zst artifact); when failed it includes error.

Returns DemoQueryStatusResponse

• error? string
• estimated_wait_seconds? int64
• format OutputFormat
• job_id string
• match_id int64
• result_url? string
• status JobStatus

curl "https://api.deadlock-api.com/v1/matches/demo/query/{job_id}"

Returns the queryable schema of a match's demo file: every entity and event table with its columns and Arrow types.

By default this returns the schema of the most recent match we have a demo for. Optionally pass match_id to read the schema for a specific match; if we don't already have its salts, they are fetched from Steam (rate limited, see /{match_id}/salts).

Returns DemoSchemaResponse

• demo_url string
• match_id int64
• tables TableSchemaResponse[]

curl "https://api.deadlock-api.com/v1/matches/demo/schema"

This endpoint returns statistics for each hero played by a given player account.

Returns HeroStats[]

• account_id int32
• accuracy number
• assists int64
• assists_per_min number
• creeps_per_min number
• crit_shot_rate number
• damage_mitigated_per_min number
• damage_per_min number
• damage_per_soul number
• damage_taken_per_min number
• damage_taken_per_soul number
• deaths int64
• deaths_per_min number
• denies_per_match number
• denies_per_min number
• ending_level number
• hero_id int32
• kills int64
• kills_per_min number
• last_hits_per_min number
• last_played int32
• matches int64[]
• matches_played int64
• networth_per_min number
• obj_damage_per_min number
• obj_damage_per_soul number
• time_played int64
• total_boss_damage int64
• total_creep_damage int64
• total_neutral_damage int64
• total_player_damage int64
• total_player_damage_taken int64
• wins int64

curl "https://api.deadlock-api.com/v1/players/hero-stats?account_ids=<account_ids>"

Deprecated alias of /v1/players/rank/image. The rank is no longer predicted, it is read from each player's latest ranked match.

Returns int32[]

curl "https://api.deadlock-api.com/v1/players/rank-predict/image?account_ids=<account_ids>"

Returns the average rank badge image (binary) for a comma-separated list of account IDs. Accounts without a rank are left out of the average; if none of them has one, the Obscurus image is returned. Use ?format=webp for WebP.

Returns int32[]

curl "https://api.deadlock-api.com/v1/players/rank/image?account_ids=<account_ids>"

This endpoint returns the player account stats for the given account_id.

!THIS IS A PATREON ONLY ENDPOINT!

You have to be friend with one of the bots to use this endpoint. On first use this endpoint will return an error with a list of invite links to add the bot as friend. From then on you can use this endpoint.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Messages:

• CMsgClientToGcGetAccountStats
• CMsgAccountStats

Returns PlayerAccountStats

• account_id int32
• stats PlayerAccountHeroStats[]

curl "https://api.deadlock-api.com/v1/players/{account_id}/account-stats"

This endpoint returns the player card for the given account_id.

!THIS IS A PATREON ONLY ENDPOINT!

You have to be friend with one of the bots to use this endpoint. On first use this endpoint will return an error with a list of invite links to add the bot as friend. From then on you can use this endpoint.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Messages:

• CMsgClientToGcGetProfileCard
• CMsgCitadelProfileCard

Returns PlayerCard

• account_id int32
• ranked_badge_level? int32
• ranked_rank? int32
• ranked_subrank? int32
• slots PlayerCardSlot[]

curl "https://api.deadlock-api.com/v1/players/{account_id}/card"

This endpoint returns the enemy stats.

Returns EnemyStats[]

• enemy_id int32
• matches int64[]
• matches_played int64
• wins int64

curl "https://api.deadlock-api.com/v1/players/{account_id}/enemy-stats"

This endpoint returns the player match history for the given account_id.

If the account is friends with one of our bots, the match history is a combination of the data from Steam and ClickHouse, so you always get the most up-to-date data and full history. If the account is not friends with a bot, only the stored match history from ClickHouse is returned.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Messages:

• CMsgClientToGcGetMatchHistory
• CMsgClientToGcGetMatchHistoryResponse

Returns PlayerMatchHistoryEntry[]

• abandoned_time_s? int32
• account_id int32
• brawl_avg_round_time_s? int32
• brawl_score_team0? int32
• brawl_score_team1? int32
• denies int32
• game_mode int32
• hero_id int32
• hero_level int32
• last_hits int32
• match_duration_s int32
• match_id int64
• match_mode int32
• match_result int32
• net_worth int32
• objectives_mask_team0 int32
• objectives_mask_team1 int32
• player_assists int32
• player_deaths int32
• player_kills int32
• player_match_outcome int32
• player_team int32
• ranked_calibration_match? int32
• ranked_delta? int32
• ranked_display_badge? int32
• ranked_used_demotion_protection? boolean
• start_time int32
• team_abandoned? boolean

curl "https://api.deadlock-api.com/v1/players/{account_id}/match-history"

This endpoint returns the mate stats.

Returns MateStats[]

• matches int64[]
• matches_played int64
• mate_id int32
• wins int64

curl "https://api.deadlock-api.com/v1/players/{account_id}/mate-stats"

Returns the player's rank at the end of their latest ranked match, i.e. the rank they entered that match with plus the progress the match awarded. A subrank spans 1000 progress points, so a single match can move the badge.

Only ranked matches carry a rank, and it stays unset while the player is in placement games. When none of the player's recent ranked matches reports a rank, badge, rank and subrank are all 0, which is the Obscurus (unranked) tier, and last_match is null.

last_match carries the rank metadata Valve reported on that match, e.g. rank progress, remaining placement games and demotion protection.

Returns RankResponse

• badge int32
• last_match? LastRankedMatch
• rank int32
• subrank int32

curl "https://api.deadlock-api.com/v1/players/{account_id}/rank"

Deprecated alias of /v1/players/{account_id}/rank. The rank is no longer predicted, it is read from the player's latest ranked match.

Returns RankResponse

• badge int32
• last_match? LastRankedMatch
• rank int32
• subrank int32

curl "https://api.deadlock-api.com/v1/players/{account_id}/rank-predict"

Deprecated alias of /v1/players/{account_id}/rank/image. The rank is no longer predicted, it is read from the player's latest ranked match.

Returns int32[]

curl "https://api.deadlock-api.com/v1/players/{account_id}/rank-predict/image"

Returns the rank badge image directly (binary), not a URL, with the player's I-VI division numeral drawn on it. Players whose recent ranked matches carry no rank, and players still in placement, get the plain tier badge. Use ?format=webp for WebP.

Returns int32[]

curl "https://api.deadlock-api.com/v1/players/{account_id}/rank/image"

Deprecated. The MMR estimate is gone, this now returns the rank Valve reported for each player at the end of their latest ranked match. Players without a ranked match carrying a rank are left out.

Use /v1/players/{account_id}/rank instead.

Returns MMRHistory[]

• account_id int32
• division int32
• division_tier int32
• match_id int64
• player_score number
• rank int32
• start_time int32

curl "https://api.deadlock-api.com/v1/players/mmr?account_ids=<account_ids>"

Deprecated. The MMR estimate is gone, this now counts players by the rank Valve reported at the end of their latest ranked match within the filtered range.

Use /v1/analytics/badge-distribution instead.

Returns DistributionEntry[]

• players int64
• rank int32

curl "https://api.deadlock-api.com/v1/players/mmr/distribution"

Deprecated. Valve reports a single account-wide rank, not a per-hero one, so this counts players by the rank they had on their latest ranked match played on that hero.

Use /v1/analytics/badge-distribution instead.

Returns DistributionEntry[]

• players int64
• rank int32

curl "https://api.deadlock-api.com/v1/players/mmr/distribution/{hero_id}"

Deprecated. Valve reports a single account-wide rank, not a per-hero one, so this returns each player's rank on their latest ranked match played on that hero.

Use /v1/players/{account_id}/rank instead.

Returns MMRHistory[]

• account_id int32
• division int32
• division_tier int32
• match_id int64
• player_score number
• rank int32
• start_time int32

curl "https://api.deadlock-api.com/v1/players/mmr/{hero_id}?account_ids=<account_ids>"

Deprecated. The MMR estimate is gone, this now returns one entry per ranked match with the rank Valve reported for the player at the end of that match.

Use the ranked_display_badge and ranked_delta fields of /v1/players/{account_id}/match-history instead.

Returns MMRHistory[]

• account_id int32
• division int32
• division_tier int32
• match_id int64
• player_score number
• rank int32
• start_time int32

curl "https://api.deadlock-api.com/v1/players/{account_id}/mmr-history"

Deprecated. Valve reports a single account-wide rank, not a per-hero one, so this returns the player's rank at the end of each ranked match they played on that hero.

Use the ranked_display_badge and ranked_delta fields of /v1/players/{account_id}/match-history instead.

Returns MMRHistory[]

• account_id int32
• division int32
• division_tier int32
• match_id int64
• player_score number
• rank int32
• start_time int32

curl "https://api.deadlock-api.com/v1/players/{account_id}/mmr-history/{hero_id}"

This endpoint returns Steam profiles of players.

Pass refresh=true to force a live refresh of the listed accounts from the Steam Web API (GetPlayerSummaries + GetFriendList) before returning. The refreshed rows are persisted to the steam_profiles table and returned in the response with last_updated set to the current time. Refresh requests are rate limited and capped at 100 account ids per call to stay inside the shared Steam Web API key budget.

See: https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerSummaries_(v0002)

Returns SteamProfile[]

• account_id int32
• avatar string
• avatarfull string
• avatarmedium string
• countrycode? string
• friends SteamFriend[]
• last_team_avg_badge? int32
• last_updated string
• matches_played_last_30d int64
• personaname string
• profileurl string
• realname? string

curl "https://api.deadlock-api.com/v1/players/steam?account_ids=<account_ids>"

This endpoint lets you search for Steam profiles by account_id or personaname.

See: https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerSummaries_(v0002)

Returns SteamProfile[]

• account_id int32
• avatar string
• avatarfull string
• avatarmedium string
• countrycode? string
• friends SteamFriend[]
• last_team_avg_badge? int32
• last_updated string
• matches_played_last_30d int64
• personaname string
• profileurl string
• realname? string

curl "https://api.deadlock-api.com/v1/players/steam-search?search_query=<search_query>"

Returns the leaderboard.

Valve updates the leaderboard once per hour.

Returns Leaderboard

• entries LeaderboardEntry[]

curl "https://api.deadlock-api.com/v1/leaderboard/{region}"

Returns the leaderboard, serialized as protobuf message.

You have to decode the protobuf message.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Message:

• CMsgClientToGcGetLeaderboardResponse

Valve updates the leaderboard once per hour.

Returns int32[]

curl "https://api.deadlock-api.com/v1/leaderboard/{region}/raw"

Returns the leaderboard for a specific hero.

Valve updates the leaderboard once per hour.

Returns Leaderboard

• entries LeaderboardEntry[]

curl "https://api.deadlock-api.com/v1/leaderboard/{region}/{hero_id}"

Returns the leaderboard for a specific hero, serialized as protobuf message.

You have to decode the protobuf message.

Protobuf definitions can be found here: https://github.com/SteamDatabase/Protobufs

Relevant Protobuf Message:

• CMsgClientToGcGetLeaderboardResponse

Valve updates the leaderboard once per hour.

Returns int32[]

curl "https://api.deadlock-api.com/v1/leaderboard/{region}/{hero_id}/raw"

Retrieves statistics for the ability order of a hero.

Returns AnalyticsAbilityOrderStats[]

• abilities int32[]
• losses int64
• matches int64
• players int64
• total_assists int64
• total_deaths int64
• total_kills int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/ability-order-stats?hero_id=<hero_id>"

This endpoint returns the player badge distribution.

total_matches counts matches by their average badge, while unique_players counts players by the rank Valve reported at the end of their latest ranked match within the filtered range. Since only ranked matches carry a rank, unique_players ignores the match_mode filter and always looks at ranked matches.

Ranks exist only from the first ranked season on, so min_unix_timestamp is clamped to its start.

Returns BadgeDistribution[]

• badge_level int32
• total_matches int64
• unique_players int64

curl "https://api.deadlock-api.com/v1/analytics/badge-distribution"

Retrieves item statistics from hero builds.

Results are cached for 1 hour based on the unique combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

Returns BuildItemStats[]

• builds int64
• item_id int64

curl "https://api.deadlock-api.com/v1/analytics/build-item-stats"

Retrieves aggregate game-level statistics.

Returns AnalyticsGameStats[]

• abandon_rate number
• avg_accuracy number
• avg_assists number
• avg_boss_damage number
• avg_creep_damage number
• avg_creep_kills number
• avg_crit_rate number
• avg_damage_absorbed number
• avg_damage_mitigated number
• avg_deaths number
• avg_denies number
• avg_duration_s number
• avg_ending_level number
• avg_first_mid_boss_time_s number
• avg_first_objective_destroyed_time_s number
• avg_gold_boss number
• avg_gold_boss_orb number
• avg_gold_death_loss number
• avg_gold_denied number
• avg_gold_lane_creep number
• avg_gold_lane_creep_orbs number
• avg_gold_neutral_creep number
• avg_gold_neutral_creep_orbs number
• avg_gold_player number
• avg_gold_player_orbs number
• avg_gold_treasure number
• avg_heal_prevented number
• avg_kd_ratio number
• avg_kills number
• avg_last_hits number
• avg_max_health number
• avg_net_worth number
• avg_neutral_damage number
• avg_neutral_kills number
• avg_player_damage number
• avg_player_damage_taken number
• avg_player_healing number
• avg_possible_creeps number
• avg_self_healing number
• avg_tech_power number
• … 7 more fields

curl "https://api.deadlock-api.com/v1/analytics/game-stats"

Retrieves ban statistics for each hero based on historical match data from demo analysis.

Only matches with successfully extracted ban data are included. Matches where ban extraction failed (empty banned_hero_ids) are excluded entirely.

Results are cached for 1 hour based on the combination of query parameters provided.

Returns HeroBanStats[]

• bans int64
• bucket int32
• hero_id int32

curl "https://api.deadlock-api.com/v1/analytics/hero-ban-stats"

Retrieves performance statistics for hero builds based on historical match data from demo analysis.

Only includes builds that exist in the hero builds database.

The hero_build_id is the first build the player had selected when the game started. It does not reflect any build changes made during the match.

Results are cached for 1 hour based on the combination of query parameters provided.

Returns HeroBuildStats[]

• hero_build_id int64
• hero_id int32
• losses int64
• matches int64
• players int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/hero-build-stats/{hero_id}"

Retrieves overall statistics for each hero combination.

Results are cached for 1 hour. The cache key is determined by the specific combination of filter parameters used in the query. Subsequent requests using the exact same filters within this timeframe will receive the cached response.

Returns HeroCombStats[]

• hero_ids int32[]
• losses int64
• matches int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/hero-comb-stats"

Retrieves hero-versus-hero matchup statistics based on historical match data.

This endpoint analyzes completed matches to calculate how often a specific hero (hero_id) wins against an enemy hero (enemy_hero_id) and the total number of times they have faced each other under the specified filter conditions.

Results are cached for 1 hour based on the combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

Returns HeroCounterStats[]

• assists int64
• creeps int64
• deaths int64
• denies int64
• enemy_assists int64
• enemy_creeps int64
• enemy_deaths int64
• enemy_denies int64
• enemy_hero_id int32
• enemy_kills int64
• enemy_last_hits int64
• enemy_networth int64
• enemy_obj_damage int64
• hero_id int32
• kills int64
• last_hits int64
• matches_played int64
• networth int64
• obj_damage int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/hero-counter-stats"

Retrieves performance statistics for each hero based on historical match data.

Returns AnalyticsHeroStats[]

• bucket int32
• hero_id int32
• losses int64
• matches int64
• matches_per_bucket int64
• total_assists int64
• total_boss_damage int64
• total_creep_damage int64
• total_deaths int64
• total_denies int64
• total_kills int64
• total_last_hits int64
• total_max_health int64
• total_net_worth int64
• total_neutral_damage int64
• total_player_damage int64
• total_player_damage_taken int64
• total_shots_hit int64
• total_shots_missed int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/hero-stats"

Retrieves hero pair synergy statistics based on historical match data.

This endpoint analyzes completed matches to calculate how often a specific pair of heroes (hero_id1 and hero_id2) won when playing *together on the same team*, and the total number of times they have played together under the specified filter conditions.

Results are cached for 1 hour based on the combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

Returns HeroSynergyStats[]

• assists1 int64
• assists2 int64
• creeps1 int64
• creeps2 int64
• deaths1 int64
• deaths2 int64
• denies1 int64
• denies2 int64
• hero_id1 int32
• hero_id2 int32
• kills1 int64
• kills2 int64
• last_hits1 int64
• last_hits2 int64
• matches_played int64
• networth1 int64
• networth2 int64
• obj_damage1 int64
• obj_damage2 int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/hero-synergy-stats"

Retrieves item build-flow statistics: per-phase item win/pick rates and the transitions between them.

Items are grouped into columns by the in-match phase they were bought in (controlled by phase_interval_s and phase_count). The response contains nodes (items aggregated within a phase) and edges (transitions between an item and items in the next phase). A locked build path can be supplied via locked_item_ids / locked_columns to restrict the population to players who bought those items in the given stage columns.

Each node also carries adjusted_win_rate: the item's win rate standardized to the stage's net-worth-at-buy distribution. Because players who are already ahead have more souls and buy items sooner, raw win rate is heavily confounded by wealth; the adjusted figure re-weights each item's win rate across net-worth buckets to the stage-wide distribution, isolating the item's contribution from the buyer's lead. It is still observational, not a controlled/causal estimate. reached_per_column gives the distinct baseline games that bought any upgrade in each column, so consumers can show how survivorship-selected (e.g. long-game-only) a late stage is.

Results are cached for 1 hour based on the unique combination of query parameters provided.

Returns ItemFlowStats

• baseline ItemFlowSummary
• edges ItemFlowEdge[]
• nodes ItemFlowNode[]
• reached_per_column int64[]
• summary ItemFlowSummary

curl "https://api.deadlock-api.com/v1/analytics/item-flow-stats"

Retrieves item permutation statistics based on historical match data.

Results are cached for 1 hour based on the unique combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

Returns ItemPermutationStats[]

• item_ids int32[]
• losses int64
• matches int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/item-permutation-stats"

Retrieves item statistics based on historical match data.

Results are cached for 6 hours based on the unique combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

Returns ItemStats[]

• avg_buy_time_relative number
• avg_buy_time_s number
• avg_sell_time_relative number
• avg_sell_time_s number
• bucket int32
• item_id int32
• losses int64
• matches int64
• players int64
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/item-stats"

This endpoint returns the kill-death statistics across a 128x128 pixel raster.

Returns KillDeathStats[]

• deaths int64
• killer_team int32
• kills int64
• position_x int32
• position_y int32

curl "https://api.deadlock-api.com/v1/analytics/kill-death-stats"

> ⚠️ Subject to change: This endpoint is newly added and not yet stable. Its parameters, response fields and semantics may change or be removed without notice.

Retrieves duo-versus-duo lane statistics: how a pair of heroes sharing a lane performed against the pair of heroes they laned against.

Win rate covers the whole match. Everything else is read at sample_time_s (900 by default, the last sample before the game's recording cadence coarsens) off the matchups that lasted that long, counted by sample_matches. Souls are always reported, in net_worth_diff; pass stats for any other per-tick stat the game records — kills, denies, player damage, healing, level and so on — each as the duo's own combined value *and* as its lead over the enemy duo.

Only lanes where *both* sides fielded exactly two players are counted, and each lane contributes one row per side, so every matchup appears twice with the two sides swapped.

group_by chooses what a row stands for. The default groups all three dimensions, giving one row per duo-versus-duo matchup per lane. Dropping enemy_hero_ids gives a duo's record across every opponent, dropping hero_ids gives what a duo is up against, and dropping assigned_lane merges the lanes. Folded dimensions come back as 0 / an empty array.

Pass hero_ids and enemy_hero_ids to scope the response to the duos you care about. Without them the full duo-versus-duo matrix is computed, which is a considerably more expensive query.

Results are cached for 1 hour. The cache key is determined by the specific combination of filter parameters used in the query. Subsequent requests using the exact same filters within this timeframe will receive the cached response.

Returns LaneMatchupStats[]

• assigned_lane int32
• enemy_hero_ids int32[]
• hero_ids int32[]
• matches_played int64
• net_worth_diff number
• sample_matches int64
• sample_time_s int32
• stats object
• wins int64

curl "https://api.deadlock-api.com/v1/analytics/lane-matchup-stats"

> ⚠️ Subject to change: This endpoint is newly added and not yet stable. Its parameters, response fields and semantics may change or be removed without notice.

Retrieves how a duo's lead over the duo they laned against develops over the course of the match.

The curve is not interpolated: it carries exactly the samples the game records, which are every 180 seconds up to the 15 minute mark and every 300 seconds after that. It runs from min_time_s (180 by default) to max_time_s, which is open by default, so a matchup is followed until its matches end. sample_matches reports how many matchups were still running at each point, and thins out towards the end of the curve.

Only lanes where *both* sides fielded exactly two players are counted, and each lane contributes one row per side, so every matchup appears twice with the two sides swapped.

Souls are always reported, in net_worth_diff. Pass stats for curves of any other per-tick stat the game records — kills, denies, player damage, healing, level and so on — each as the duo's own combined value *and* as its lead over the enemy duo.

group_by chooses what a row stands for. The default groups all three dimensions, giving one row per duo-versus-duo matchup per lane. Dropping enemy_hero_ids gives a duo's curve across every opponent, dropping hero_ids gives what a duo is up against, and dropping assigned_lane merges the lanes. Folded dimensions come back as 0 / an empty array.

Pass hero_ids and enemy_hero_ids to scope the response to the duos you care about. Without them the full duo-versus-duo matrix is computed, which is a considerably more expensive query.

Results are cached for 1 hour based on the combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

Returns LaneSoulCurve[]

• assigned_lane int32
• enemy_hero_ids int32[]
• hero_ids int32[]
• matches_played int64
• net_worth_diff number[]
• net_worth_diff_std number[]
• sample_matches int64[]
• sample_times_s int32[]
• stats object

curl "https://api.deadlock-api.com/v1/analytics/lane-soul-curve"

Retrieves player performance statistics (net worth, kills, deaths, assists) over time throughout matches.

Results are cached for 1 hour based on the unique combination of query parameters provided.

Returns PlayerPerformanceCurvePoint[]

• assists_avg number
• assists_std number
• deaths_avg number
• deaths_std number
• game_time int32
• gold_boss_avg number
• gold_boss_orb_avg number
• gold_death_loss_avg number
• gold_denied_avg number
• gold_lane_creep_avg number
• gold_lane_creep_orbs_avg number
• gold_neutral_creep_avg number
• gold_neutral_creep_orbs_avg number
• gold_player_avg number
• gold_player_orbs_avg number
• gold_treasure_avg number
• kills_avg number
• kills_std number
• net_worth_avg number
• net_worth_std number

curl "https://api.deadlock-api.com/v1/analytics/player-performance-curve"

Returns comprehensive statistical analysis of player performance.

Results are cached for 1 hour based on the unique combination of query parameters provided. Subsequent identical requests within this timeframe will receive the cached response.

> Note: Quantiles are calculated using the DDSketch algorithm, so they are not exact but have a maximum relative error of 0.01.

Returns HashMap

curl "https://api.deadlock-api.com/v1/analytics/player-stats/metrics"

This endpoint returns the hero scoreboard.

Returns HeroEntry[]

• hero_id int32
• matches int64
• rank int64
• value number

curl "https://api.deadlock-api.com/v1/analytics/scoreboards/heroes?sort_by=<sort_by>"

This endpoint returns the player scoreboard.

Returns PlayerEntry[]

• account_id int32
• matches int64
• rank int64
• value number

curl "https://api.deadlock-api.com/v1/analytics/scoreboards/players?sort_by=<sort_by>"

Search for builds based on various criteria.

Returns Build[]

• hero_build BuildHero
• num_favorites? int32
• num_ignores? int32
• num_reports? int32
• num_weekly_favorites? int32
• rollup_category? int32

curl "https://api.deadlock-api.com/v1/builds"

Resolves a command and returns the resolved command.

Returns string

curl "https://api.deadlock-api.com/v1/commands/resolve?account_id=<account_id>"

Returns a list of available variables that can be used in the command endpoint.

Returns VariableDescription[]

• category VariableCategory
• default_label? string
• description string
• extra_args string[]
• name string

curl "https://api.deadlock-api.com/v1/commands/variables/available"

Resolves variables and returns a map of variable name to resolved value.

Returns object

curl "https://api.deadlock-api.com/v1/commands/variables/resolve?account_id=<account_id>"

Returns a map of str->int of widget versions.

Returns object

curl "https://api.deadlock-api.com/v1/commands/widgets/versions"

Returns information about the API.

Returns APIInfo

• fetched_matches_per_day? int64
• table_sizes? object
• user_ingested_matches_last24h? int64

curl "https://api.deadlock-api.com/v1/info"

Checks the health of the services.

Returns Status

• services StatusServices

curl "https://api.deadlock-api.com/v1/info/health"

Executes a SQL query on the database.

Returns string

curl "https://api.deadlock-api.com/v1/sql?query=<query>"

Lists all tables in the database.

Returns string[]

curl "https://api.deadlock-api.com/v1/sql/tables"

Returns the schema of a table.

Returns object

curl "https://api.deadlock-api.com/v1/sql/tables/{table}/schema"

Returns all currently active game servers.

Returns ListServersResponse

• servers GameServerInfo[]

curl "https://api.deadlock-api.com/v1/servers"

Ingests a single metric event reported by a game server. The schema is intentionally flexible: metric_value carries the primary numeric measurement and metadata holds arbitrary key/value context that varies per game mode or metric. Optional map and game_mode_version let callers segment leaderboards per map or per ruleset revision. Requires a valid game server secret as a Bearer token.

curl -X POST "https://api.deadlock-api.com/v1/servers/metrics"

Reports the current status of a game server. Game servers must call this endpoint at least once every 30 seconds to remain active. Requires a valid game server secret as a Bearer token.

Returns ServerStatusResponse

• server_id string
• ttl_secs int64

curl -X POST "https://api.deadlock-api.com/v1/servers/status"

Returns the list of Deadlock game servers registered with the Steam master server (IGameServersService/GetServerList), filtered to Deadlock's appid.

Returns SteamServer[]

• addr string
• appid int32
• bots int32
• dedicated boolean
• gamedir string
• gameport int32
• gametype string
• map string
• max_players int32
• name string
• os string
• players int32
• product string
• region int32
• secure boolean
• steamid string
• version string

curl "https://api.deadlock-api.com/v1/servers/steam"

Returns the per-accolade metadata used by the game client, parsed from the patch's KV3 source files.

Returns Accolade[]

• class_name string
• description string
• enabled_game_modes? string[]
• flavor_name string
• id int32
• threshold_type string
• tracked_stat_name string

curl "https://api.deadlock-api.com/v1/assets/accolades"

Returns a single accolade by class_name or tracked_stat_name (case-insensitive).

Returns Accolade

• class_name string
• description string
• enabled_game_modes? string[]
• flavor_name string
• id int32
• threshold_type string
• tracked_stat_name string

curl "https://api.deadlock-api.com/v1/assets/accolades/by-name/{name}"

Returns a single accolade by id.

Returns Accolade

• class_name string
• description string
• enabled_game_modes? string[]
• flavor_name string
• id int32
• threshold_type string
• tracked_stat_name string

curl "https://api.deadlock-api.com/v1/assets/accolades/{accolade_id}"

Returns the build tag taxonomy used by the game client, derived from per-version localization keys.

Returns BuildTag[]

• class_name string
• icon string
• id int32
• label string

curl "https://api.deadlock-api.com/v1/assets/build-tags"

Returns a single build tag by class_name (case-insensitive).

Returns BuildTag

• class_name string
• icon string
• id int32
• label string

curl "https://api.deadlock-api.com/v1/assets/build-tags/by-name/{name}"

Returns a single build tag by id.

Returns BuildTag

• class_name string
• icon string
• id int32
• label string

curl "https://api.deadlock-api.com/v1/assets/build-tags/{build_tag_id}"

Returns all known Deadlock client/game versions for which versioned assets are available, sorted ascending (oldest first).

Returns int32[]

curl "https://api.deadlock-api.com/v1/assets/client-versions"

Panorama color palette (@define <name>: #RRGGBB[AA]; declarations from citadel_base_styles.css), keyed by snake_case name.

Returns object

curl "https://api.deadlock-api.com/v1/assets/colors"

Returns the game-wide generic configuration (street brawl, lane info, glitch settings, damage flash, item draft, etc.) parsed from the patch's generic_data.vdata KV3 source file.

Returns GenericData

• aim_spring_strength number[]
• armor_groups ItemGroup[]
• damage_flash DamageFlash
• enemy_objectives_and_zipline_color? Color
• enemy_objectives_color? Color
• enemy_zipline_color? Color
• glitch_settings GlitchSettings
• hero_kill_gold_share_frac number[]
• item_price_per_tier int64[]
• lane_info LaneInfo[]
• mini_map_offsets MiniMapOffsets[]
• minimap_team_combine_color? Color
• minimap_team_rebels_color? Color
• new_player_metrics NewPlayerMetrics[]
• objective_params ObjectiveParams
• rejuv_params RejuvParams
• spirit_groups ItemGroup[]
• street_brawl? StreetBrawl
• targeting_spring_strength number[]
• trooper_kill_gold_share_frac number[]
• weapon_groups ItemGroup[]

curl "https://api.deadlock-api.com/v1/assets/generic-data"

Returns the per-hero metadata used by the game client, parsed from the patch's KV3 source files.

Returns Hero[]

• assigned_players_only boolean
• class_name string
• colors HeroColors
• complexity int64
• cost_bonuses? HashMap_ItemSlotType_Vec_MapModCostBonus
• description HeroDescription
• disabled boolean
• gun_tag? string
• hero_stats_ui HeroStatsUI
• hero_type? HeroType
• hideout_rich_presence? string
• id int32
• images HeroImages
• in_development boolean
• item_draft_bucketing? HashMap_String_Option_DraftBucketing
• item_draft_weights? HashMap_String_f64
• item_slot_info HashMap_ItemSlotType_ItemSlotInfo
• items HashMap_HeroItemType_String
• level_info HashMap_String_LevelInfo
• limited_testing boolean
• name string
• needs_testing boolean
• physics HeroPhysics
• player_selectable boolean
• prerelease_only? boolean
• purchase_bonuses HashMap_ItemSlotType_Vec_PurchaseBonus
• scaling_stats HashMap_String_ScalingStat
• shop_stat_display ShopStatDisplay
• skin int64
• standard_level_up_upgrades HashMap_String_f64
• starting_stats StartingStats
• stats_display StatsDisplay
• tags string[]

curl "https://api.deadlock-api.com/v1/assets/heroes"

Returns a single hero by class_name or display name. Matches the bare value as well as the hero_-prefixed form.

Returns Hero

• assigned_players_only boolean
• class_name string
• colors HeroColors
• complexity int64
• cost_bonuses? HashMap_ItemSlotType_Vec_MapModCostBonus
• description HeroDescription
• disabled boolean
• gun_tag? string
• hero_stats_ui HeroStatsUI
• hero_type? HeroType
• hideout_rich_presence? string
• id int32
• images HeroImages
• in_development boolean
• item_draft_bucketing? HashMap_String_Option_DraftBucketing
• item_draft_weights? HashMap_String_f64
• item_slot_info HashMap_ItemSlotType_ItemSlotInfo
• items HashMap_HeroItemType_String
• level_info HashMap_String_LevelInfo
• limited_testing boolean
• name string
• needs_testing boolean
• physics HeroPhysics
• player_selectable boolean
• prerelease_only? boolean
• purchase_bonuses HashMap_ItemSlotType_Vec_PurchaseBonus
• scaling_stats HashMap_String_ScalingStat
• shop_stat_display ShopStatDisplay
• skin int64
• standard_level_up_upgrades HashMap_String_f64
• starting_stats StartingStats
• stats_display StatsDisplay
• tags string[]

curl "https://api.deadlock-api.com/v1/assets/heroes/by-name/{name}"

Returns a single hero by id.

Returns Hero

• assigned_players_only boolean
• class_name string
• colors HeroColors
• complexity int64
• cost_bonuses? HashMap_ItemSlotType_Vec_MapModCostBonus
• description HeroDescription
• disabled boolean
• gun_tag? string
• hero_stats_ui HeroStatsUI
• hero_type? HeroType
• hideout_rich_presence? string
• id int32
• images HeroImages
• in_development boolean
• item_draft_bucketing? HashMap_String_Option_DraftBucketing
• item_draft_weights? HashMap_String_f64
• item_slot_info HashMap_ItemSlotType_ItemSlotInfo
• items HashMap_HeroItemType_String
• level_info HashMap_String_LevelInfo
• limited_testing boolean
• name string
• needs_testing boolean
• physics HeroPhysics
• player_selectable boolean
• prerelease_only? boolean
• purchase_bonuses HashMap_ItemSlotType_Vec_PurchaseBonus
• scaling_stats HashMap_String_ScalingStat
• shop_stat_display ShopStatDisplay
• skin int64
• standard_level_up_upgrades HashMap_String_f64
• starting_stats StartingStats
• stats_display StatsDisplay
• tags string[]