{ "openapi": "3.1.1", "info": { "title": "WD Stats API", "description": "Read-only WARDOGS stats from WD Stats: leaderboards, public players, seasons and community servers. Every request needs a key (Authorization: Bearer wds_…), made on your account page. Guide and terms: https://wdstats.co.uk/developers", "version": "1" }, "servers": [ { "url": "https://wdstats.co.uk" } ], "paths": { "/api/v1/status": { "get": { "tags": [ "WardogStats.Api" ], "summary": "The API and the live season", "description": "The live season and the day it started on WD Stats, how many players are ranked in it, and when the standings were last worked out (about once a minute).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/seasons": { "get": { "tags": [ "WardogStats.Api" ], "summary": "Seasons", "description": "Every season with stats on WD Stats, oldest first: when it started, its players, and whether it's live or final.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeasonInfo" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/seasons/{season}/payout": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A season's cash-to-gold payout", "description": "What the game paid public players in gold bars for the cash they ended a season with: how many it has summed up, how many got a bar, the median cash left, the most bars and all bars paid.", "parameters": [ { "name": "season", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeasonPayoutResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/boards": { "get": { "tags": [ "WardogStats.Api" ], "summary": "Leaderboards", "description": "Every leaderboard's id (as in the site's address), its name, what its value is and what breaks ties.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardInfo" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/boards/{board}": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A leaderboard", "description": "One page of a board (pageSize up to 100, 5,000 rows deep), for the live season or a finished one (?season=). Players who tie share a rank.", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "season", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/players/{key}": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A player", "description": "One public player by SteamID (if they show it) or public id: level, XP, unlocks, wallet, classes, and their standing on every board with how it moved. ?season= for one of their earlier seasons.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "season", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/players/{key}/seasons": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A player's seasons", "description": "The player's totals in each season they have stats in, oldest first. A finished season's figures are final.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayerSeasonsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/players/{key}/history": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A player's progress", "description": "One point a day (UTC) for the player's latest season: their XP and level at the end of each day they played. Enough for a graph; WD Stats doesn't share the hour-by-hour trail.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/players/{key}/combat": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A player's community-server stats", "description": "Totals from community servers connected to WD Stats for a season (default: the latest they played): matches, kills, deaths, results, time played and their best match, and the servers they come from. 404 if the player keeps them private.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "season", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CombatResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/players/{key}/matches": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A player's community matches", "description": "The player's latest matches on connected community servers, newest first (limit up to 50): server, map, result, kills, deaths, when it ended and its page on WD Stats.", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "season", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/movers": { "get": { "tags": [ "WardogStats.Api" ], "summary": "This week's biggest climbers", "description": "The top five over the last 7 days by career XP gained, Wardog levels gained and cash made, and the biggest single-class grinds.", "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoversResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/milestones": { "get": { "tags": [ "WardogStats.Api" ], "summary": "Latest milestones", "description": "The latest milestones in the live season (limit up to 100), grouped by player, newest first: Wardog and class levels, career XP, cash and unlocks.", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MilestoneGroup" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/community/leaderboard": { "get": { "tags": [ "WardogStats.Api" ], "summary": "The community-server leaderboard", "description": "Everyone with a match on a connected community server in a season, 50 a page, by kills, deaths, kd, winrate, matches, headshots, longest, streak, cash or time; ?server= for one server's players. K/D and win rate rank players with 3 or more matches.", "parameters": [ { "name": "season", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "server", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunityBoardResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/community/servers": { "get": { "tags": [ "WardogStats.Api" ], "summary": "Connected community servers", "description": "Every community server connected to WD Stats (collecting or paused), the most recently played first, with what was recorded on each and on all of them.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/community/servers/{id}": { "get": { "tags": [ "WardogStats.Api" ], "summary": "A community server", "description": "One connected server in a community season: what was recorded there and its top 10 players by kills.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "season", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/patch-notes": { "get": { "tags": [ "WardogStats.Api" ], "summary": "Bulkhead's announcements", "description": "WARDOGS patch notes and news from Steam, newest first (limit up to 50): title, kind, when it was posted, and links to it on Steam and WD Stats. The text is Bulkhead's, so it isn't included.", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchNoteEntry" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "BoardInfo": { "required": [ "id", "label", "value", "tieBreak" ], "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "tieBreak": { "type": [ "null", "string" ] } } }, "BoardPageResponse": { "required": [ "board", "season", "page", "pageSize", "total", "pages", "rows" ], "type": "object", "properties": { "board": { "$ref": "#/components/schemas/BoardInfo" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "page": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pageSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/BoardRow" } } } }, "BoardRow": { "required": [ "rank", "change", "player", "value", "tieBreak" ], "type": "object", "properties": { "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "change": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RankChange" } ] }, "player": { "$ref": "#/components/schemas/PlayerSummary" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "tieBreak": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } } }, "ClassRef": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "ClassStat": { "required": [ "id", "name", "level", "xp" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "level": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "xp": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "CombatResponse": { "required": [ "key", "season", "seasons", "totals", "servers" ], "type": "object", "properties": { "key": { "type": "string" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "seasons": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "totals": { "$ref": "#/components/schemas/CombatTotals" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/CombatServer" } } } }, "CombatServer": { "required": [ "id", "name", "matches", "kills", "deaths", "url" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "matches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "deaths": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "url": { "type": "string" } } }, "CombatTotals": { "required": [ "matches", "kills", "deaths", "wins", "losses", "draws", "seconds", "bestMatchKills" ], "type": "object", "properties": { "matches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "deaths": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "wins": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "losses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "draws": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "bestMatchKills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "CommunityBoardResponse": { "required": [ "season", "currentSeason", "seasons", "sort", "page", "pageSize", "total", "pages", "minMatches", "server", "rows" ], "type": "object", "properties": { "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "currentSeason": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "seasons": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "sort": { "type": "string" }, "page": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pageSize": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "pages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "minMatches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "server": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ServerRef" } ] }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CommunityRow" } } } }, "CommunityRow": { "required": [ "rank", "person", "matches", "wins", "losses", "draws", "winRate", "kills", "deaths", "kd", "headshots", "headshotPct", "longestKillM", "bestKillStreak", "cash", "seconds" ], "type": "object", "properties": { "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "person": { "$ref": "#/components/schemas/Person" }, "matches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "wins": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "losses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "draws": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "winRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "deaths": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "kd": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "headshots": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "headshotPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "longestKillM": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "bestKillStreak": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "HistoryPoint": { "required": [ "day", "xp", "level" ], "type": "object", "properties": { "day": { "type": "string", "format": "date" }, "xp": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "level": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "HistoryResponse": { "required": [ "key", "season", "range", "points" ], "type": "object", "properties": { "key": { "type": "string" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "range": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryPoint" } } } }, "MatchEntry": { "required": [ "id", "server", "map", "result", "kills", "deaths", "endedAt", "url" ], "type": "object", "properties": { "id": { "type": "string" }, "server": { "$ref": "#/components/schemas/ServerRef" }, "map": { "type": "string" }, "result": { "type": "string" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "deaths": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "endedAt": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } }, "MatchesResponse": { "required": [ "key", "season", "matches" ], "type": "object", "properties": { "key": { "type": "string" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/MatchEntry" } } } }, "Milestone": { "required": [ "kind", "class", "value", "on" ], "type": "object", "properties": { "kind": { "type": "string" }, "class": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ClassRef" } ] }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "on": { "type": "string", "format": "date" } } }, "MilestoneGroup": { "required": [ "player", "milestones" ], "type": "object", "properties": { "player": { "$ref": "#/components/schemas/PlayerSummary" }, "milestones": { "type": "array", "items": { "$ref": "#/components/schemas/Milestone" } } } }, "Mover": { "required": [ "player", "value", "class" ], "type": "object", "properties": { "player": { "$ref": "#/components/schemas/PlayerSummary" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "class": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ClassRef" } ] } } }, "MoversResponse": { "required": [ "period", "xp", "levels", "cash", "classes" ], "type": "object", "properties": { "period": { "type": "string" }, "xp": { "type": "array", "items": { "$ref": "#/components/schemas/Mover" } }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/Mover" } }, "cash": { "type": "array", "items": { "$ref": "#/components/schemas/Mover" } }, "classes": { "type": "array", "items": { "$ref": "#/components/schemas/Mover" } } } }, "NetworkTotals": { "required": [ "servers", "matches", "kills", "players" ], "type": "object", "properties": { "servers": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "matches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "players": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "PatchNoteEntry": { "required": [ "id", "title", "kind", "postedAt", "steamUrl", "url" ], "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "postedAt": { "type": "string", "format": "date-time" }, "steamUrl": { "type": "string" }, "url": { "type": "string" } } }, "Person": { "required": [ "name", "key", "onWdStats", "avatarUrl", "profileUrl" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": [ "null", "string" ] }, "onWdStats": { "type": "boolean" }, "avatarUrl": { "type": [ "null", "string" ] }, "profileUrl": { "type": [ "null", "string" ] } } }, "PlayerResponse": { "required": [ "key", "steamId", "name", "avatarUrl", "profileUrl", "season", "latestSeason", "seasons", "updatedOn", "level", "xp", "unlocks", "wallet", "classes", "standings" ], "type": "object", "properties": { "key": { "type": "string" }, "steamId": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "profileUrl": { "type": "string" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latestSeason": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "seasons": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "updatedOn": { "type": "string", "format": "date" }, "level": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "xp": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "unlocks": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "wallet": { "$ref": "#/components/schemas/Wallet" }, "classes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassStat" } }, "standings": { "type": "array", "items": { "$ref": "#/components/schemas/Standing" } } } }, "PlayerSeasonEntry": { "required": [ "season", "status", "level", "xp", "unlocks", "wallet", "classes", "ended" ], "type": "object", "properties": { "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": "string" }, "level": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "xp": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "unlocks": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "wallet": { "$ref": "#/components/schemas/Wallet" }, "classes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassStat" } }, "ended": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SeasonEnd" } ] } } }, "PlayerSeasonsResponse": { "required": [ "key", "seasons" ], "type": "object", "properties": { "key": { "type": "string" }, "seasons": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerSeasonEntry" } } } }, "PlayerSummary": { "required": [ "key", "steamId", "name", "avatarUrl", "level", "profileUrl" ], "type": "object", "properties": { "key": { "type": "string" }, "steamId": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "level": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "profileUrl": { "type": "string" } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "RankChange": { "required": [ "today", "week" ], "type": "object", "properties": { "today": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "week": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } } }, "SeasonEnd": { "required": [ "cash", "goldBars" ], "type": "object", "properties": { "cash": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "goldBars": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "SeasonInfo": { "required": [ "season", "startedOn", "players", "status" ], "type": "object", "properties": { "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startedOn": { "type": [ "null", "string" ], "format": "date" }, "players": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "status": { "type": "string" } } }, "SeasonPayoutResponse": { "required": [ "season", "players", "paid", "medianCash", "mostBars", "totalBars" ], "type": "object", "properties": { "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "players": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paid": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "medianCash": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mostBars": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalBars": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "ServerRef": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "ServerResponse": { "required": [ "id", "name", "community", "status", "url", "season", "seasons", "totals", "topPlayers" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "community": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "url": { "type": "string" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "seasons": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "totals": { "$ref": "#/components/schemas/ServerSeasonTotals" }, "topPlayers": { "type": "array", "items": { "$ref": "#/components/schemas/CommunityRow" } } } }, "ServerSeasonTotals": { "required": [ "matches", "players", "kills", "seconds" ], "type": "object", "properties": { "matches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "players": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "seconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "ServerSummary": { "required": [ "id", "name", "community", "status", "matches", "players", "kills", "lastMatchAt", "url" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "community": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "matches": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "players": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "kills": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "lastMatchAt": { "type": [ "null", "string" ], "format": "date-time" }, "url": { "type": "string" } } }, "ServersResponse": { "required": [ "totals", "servers" ], "type": "object", "properties": { "totals": { "$ref": "#/components/schemas/NetworkTotals" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/ServerSummary" } } } }, "Standing": { "required": [ "board", "value", "rank", "of", "change" ], "type": "object", "properties": { "board": { "type": "string" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "of": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "change": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RankChange" } ] } } }, "StatusResponse": { "required": [ "api", "season", "seasonStartedOn", "rankedPlayers", "standingsBuiltAt" ], "type": "object", "properties": { "api": { "type": "string" }, "season": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "seasonStartedOn": { "type": [ "null", "string" ], "format": "date" }, "rankedPlayers": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "standingsBuiltAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "Wallet": { "required": [ "cash", "gold" ], "type": "object", "properties": { "cash": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "gold": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } } }, "securitySchemes": { "key": { "type": "http", "description": "Your API key from your WD Stats account page.", "scheme": "bearer", "bearerFormat": "wds_ key" } } }, "security": [ { "key": [ ] } ], "tags": [ { "name": "WardogStats.Api" } ] }