{"openapi":"3.1.0","info":{"title":"PUBG (BYOK) API","version":"0.1.0","description":"PUBG (BYOK) lets an AI assistant read your own PUBG data through the PUBG API with a key you supply (PUBG developer API key). Read-only: 10 tools (list_seasons, search_players, get_player, get_player_season_stats, get_player_ranked_stats, get_player_lifetime_stats, get_leaderboard, get_match, get_clan, get_sample_matches). The BYOK key travels with each request, is used for that one call only and...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-pubg.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-pubg/docs"},"termsOfService":"https://connectorbay.com/byok-pubg/terms"},"servers":[{"url":"https://byok-pubg.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-pubg/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_seasons":{"post":{"operationId":"list_seasons","summary":"List the seasons available on a platform, flagging the current one. Season ids feed the stats and leaderboard tools. The","description":"List the seasons available on a platform, flagging the current one. Season ids feed the stats and leaderboard tools. The list changes about every two months. Use for \"Which PUBG seasons exist and which one is current\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"}},"required":["platform"],"title":"list_seasonsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_players":{"post":{"operationId":"search_players","summary":"Look up up to 10 PUBG players by in-game name (case sensitive) or by account id, returning account id, name, ban status ","description":"Look up up to 10 PUBG players by in-game name (case sensitive) or by account id, returning account id, name, ban status and recent match ids. Give names or ids, not both. Use for \"What is the PUBG account id of the player WackyJacky101\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"player_names":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated in-game names, up to 10; names are case sensitive.","title":"Player Names"},"player_ids":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated account ids, up to 10 (use instead of names).","title":"Player Ids"}},"required":["platform"],"title":"search_playersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_player":{"post":{"operationId":"get_player","summary":"Get one player by account id: in-game name, ban status and the ids of matches played in the last 14 days. Use for \"Show ","description":"Get one player by account id: in-game name, ban status and the ids of matches played in the last 14 days. Use for \"Show the PUBG profile and recent match ids for account account.c0e530e9b7244b358def282782f893af\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"account_id":{"description":"Player account id, for example 'account.c0e530e9b7244b358def282782f893af' (from a player search).","maxLength":200,"title":"Account Id","type":"string"}},"required":["platform","account_id"],"title":"get_playerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_player_season_stats":{"post":{"operationId":"get_player_season_stats","summary":"Get a player's stats for one season, per game mode: wins, kills, damage, headshots, survival time, rank points and dista","description":"Get a player's stats for one season, per game mode: wins, kills, damage, headshots, survival time, rank points and distances. Use the platform shard for seasons since the Survival Title system. Use for \"What were this player's squad stats in a PUBG season\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"account_id":{"description":"Player account id, for example 'account.c0e530e9b7244b358def282782f893af' (from a player search).","maxLength":200,"title":"Account Id","type":"string"},"season_id":{"description":"Season id from list_seasons, for example 'division.bro.official.pc-2018-01'.","maxLength":200,"title":"Season Id","type":"string"},"gamepad":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only gamepad stats (relevant for console players).","title":"Gamepad"}},"required":["platform","account_id","season_id"],"title":"get_player_season_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_player_ranked_stats":{"post":{"operationId":"get_player_ranked_stats","summary":"Get a player's ranked-mode stats for one season: current and best tier, rank points, K/D/A, average rank and win ratio. ","description":"Get a player's ranked-mode stats for one season: current and best tier, rank points, K/D/A, average rank and win ratio. Use for \"What is this player's ranked tier in a PUBG season\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"account_id":{"description":"Player account id, for example 'account.c0e530e9b7244b358def282782f893af' (from a player search).","maxLength":200,"title":"Account Id","type":"string"},"season_id":{"description":"Season id from list_seasons, for example 'division.bro.official.pc-2018-01'.","maxLength":200,"title":"Season Id","type":"string"}},"required":["platform","account_id","season_id"],"title":"get_player_ranked_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_player_lifetime_stats":{"post":{"operationId":"get_player_lifetime_stats","summary":"Get a player's lifetime stats across all seasons, per game mode: wins, kills, damage, headshots, distances and survival ","description":"Get a player's lifetime stats across all seasons, per game mode: wins, kills, damage, headshots, distances and survival time. Use for \"What are this player's lifetime PUBG stats\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"account_id":{"description":"Player account id, for example 'account.c0e530e9b7244b358def282782f893af' (from a player search).","maxLength":200,"title":"Account Id","type":"string"},"gamepad":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only gamepad stats (relevant for console players).","title":"Gamepad"}},"required":["platform","account_id"],"title":"get_player_lifetime_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_leaderboard":{"post":{"operationId":"get_leaderboard","summary":"Get the top-ranked players (up to 500) for a game mode in a season, with rank, name, rank points, wins, kills and K/D/A.","description":"Get the top-ranked players (up to 500) for a game mode in a season, with rank, name, rank points, wins, kills and K/D/A. Updated about every two hours. Use for \"Who is at the top of the PUBG squad leaderboard this season\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam, kakao, psn, xbox or console (use a platform-region shard such as pc-na for regional boards).","enum":["steam","kakao","psn","xbox","console","pc-as","pc-eu","pc-jp","pc-krjp","pc-kakao","pc-na","pc-oc","pc-ru","pc-sa","pc-sea"],"title":"Platform","type":"string"},"season_id":{"description":"Season id from list_seasons, for example 'division.bro.official.pc-2018-01'.","maxLength":200,"title":"Season Id","type":"string"},"game_mode":{"description":"Game mode: solo, duo, squad or their first-person variants (solo-fpp, duo-fpp, squad-fpp).","enum":["solo","solo-fpp","duo","duo-fpp","squad","squad-fpp"],"title":"Game Mode","type":"string"}},"required":["platform","season_id","game_mode"],"title":"get_leaderboardArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_match":{"post":{"operationId":"get_match","summary":"Get one match by id: map, mode, duration, creation time, match type and the ids of its rosters and participants (the inc","description":"Get one match by id: map, mode, duration, creation time, match type and the ids of its rosters and participants (the included records hold per-player results). Use for \"What map and mode was this PUBG match\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"match_id":{"description":"Match id (a UUID) taken from a player's recent matches or the samples list.","maxLength":200,"title":"Match Id","type":"string"}},"required":["platform","match_id"],"title":"get_matchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_clan":{"post":{"operationId":"get_clan","summary":"Get a clan by id: name, tag, level and member count. Use for \"What is the name and level of this PUBG clan\".","description":"Get a clan by id: name, tag, level and member count. Use for \"What is the name and level of this PUBG clan\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam (PC), kakao, psn or xbox.","enum":["steam","kakao","psn","xbox"],"title":"Platform","type":"string"},"clan_id":{"description":"Clan id, for example 'clan.0f0e...' as returned by a player lookup.","maxLength":200,"title":"Clan Id","type":"string"}},"required":["platform","clan_id"],"title":"get_clanArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sample_matches":{"post":{"operationId":"get_sample_matches","summary":"Get a sample of recent match ids for a platform (at least 24 hours old), useful for finding matches to inspect. Use for ","description":"Get a sample of recent match ids for a platform (at least 24 hours old), useful for finding matches to inspect. Use for \"Give me some recent PUBG sample match ids\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform":{"description":"Platform shard: steam, kakao or console.","enum":["steam","kakao","console"],"title":"Platform","type":"string"},"created_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the sample window in UTC, for example 2026-10-01T00:00:00Z; must be at least 24 hours in the past (default: latest sample).","title":"Created After"}},"required":["platform"],"title":"get_sample_matchesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}