valorant-api-types
Version:
A collection of documented endpoints and return types for the unofficial Valorant API
728 lines (727 loc) • 30.9 kB
TypeScript
import { z } from 'zod';
export declare const pregameMatchEndpoint: {
readonly name: "Pre-Game Match";
readonly description: "Get Pre-Game match data";
readonly queryName: "Pregame_GetMatch";
readonly category: "Pre-Game Endpoints";
readonly type: "glz";
readonly suffix: "pregame/v1/matches/{pre-game match id}";
readonly riotRequirements: {
readonly token: true;
readonly entitlement: true;
readonly clientPlatform: true;
readonly clientVersion: true;
};
readonly responses: {
readonly '200': z.ZodObject<{
ID: z.ZodString;
Version: z.ZodNumber;
Teams: z.ZodArray<z.ZodObject<{
TeamID: z.ZodUnion<[z.ZodEnum<["Blue", "Red"]>, z.ZodString]>;
Players: z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
CharacterID: z.ZodString;
CharacterSelectionState: z.ZodEnum<["", "selected", "locked"]>;
PregamePlayerState: z.ZodEnum<["joined"]>;
CompetitiveTier: z.ZodNumber;
PlayerIdentity: z.ZodObject<{
Subject: z.ZodString;
PlayerCardID: z.ZodString;
PlayerTitleID: z.ZodString;
AccountLevel: z.ZodNumber;
PreferredLevelBorderID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
Incognito: z.ZodBoolean;
HideAccountLevel: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}>;
SeasonalBadgeInfo: z.ZodObject<{
SeasonID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
NumberOfWins: z.ZodNumber;
WinsByTier: z.ZodNull;
Rank: z.ZodNumber;
LeaderboardRank: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
}, {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
}>;
IsCaptain: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}, {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}>, "many">;
}, "strip", z.ZodTypeAny, {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}, {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}>, "many">;
AllyTeam: z.ZodNullable<z.ZodObject<{
TeamID: z.ZodUnion<[z.ZodEnum<["Blue", "Red"]>, z.ZodString]>;
Players: z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
CharacterID: z.ZodString;
CharacterSelectionState: z.ZodEnum<["", "selected", "locked"]>;
PregamePlayerState: z.ZodEnum<["joined"]>;
CompetitiveTier: z.ZodNumber;
PlayerIdentity: z.ZodObject<{
Subject: z.ZodString;
PlayerCardID: z.ZodString;
PlayerTitleID: z.ZodString;
AccountLevel: z.ZodNumber;
PreferredLevelBorderID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
Incognito: z.ZodBoolean;
HideAccountLevel: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}>;
SeasonalBadgeInfo: z.ZodObject<{
SeasonID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
NumberOfWins: z.ZodNumber;
WinsByTier: z.ZodNull;
Rank: z.ZodNumber;
LeaderboardRank: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
}, {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
}>;
IsCaptain: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}, {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}>, "many">;
}, "strip", z.ZodTypeAny, {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}, {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}>>;
EnemyTeam: z.ZodNullable<z.ZodObject<{
TeamID: z.ZodUnion<[z.ZodEnum<["Blue", "Red"]>, z.ZodString]>;
Players: z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
CharacterID: z.ZodString;
CharacterSelectionState: z.ZodEnum<["", "selected", "locked"]>;
PregamePlayerState: z.ZodEnum<["joined"]>;
CompetitiveTier: z.ZodNumber;
PlayerIdentity: z.ZodObject<{
Subject: z.ZodString;
PlayerCardID: z.ZodString;
PlayerTitleID: z.ZodString;
AccountLevel: z.ZodNumber;
PreferredLevelBorderID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
Incognito: z.ZodBoolean;
HideAccountLevel: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}>;
SeasonalBadgeInfo: z.ZodObject<{
SeasonID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
NumberOfWins: z.ZodNumber;
WinsByTier: z.ZodNull;
Rank: z.ZodNumber;
LeaderboardRank: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
}, {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
}>;
IsCaptain: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}, {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}>, "many">;
}, "strip", z.ZodTypeAny, {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}, {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}>>;
ObserverSubjects: z.ZodArray<z.ZodUnknown, "many">;
MatchCoaches: z.ZodArray<z.ZodUnknown, "many">;
EnemyTeamSize: z.ZodNumber;
EnemyTeamLockCount: z.ZodNumber;
PregameState: z.ZodEnum<["character_select_active", "provisioned"]>;
LastUpdated: z.ZodEffects<z.ZodString, Date, string>;
MapID: z.ZodString;
MapSelectPool: z.ZodArray<z.ZodUnknown, "many">;
BannedMapIDs: z.ZodArray<z.ZodUnknown, "many">;
CastedVotes: z.ZodUnknown;
MapSelectSteps: z.ZodArray<z.ZodUnknown, "many">;
MapSelectStep: z.ZodNumber;
Team1: z.ZodUnion<[z.ZodEnum<["Blue", "Red"]>, z.ZodString]>;
GamePodID: z.ZodString;
Mode: z.ZodString;
VoiceSessionID: z.ZodString;
MUCName: z.ZodString;
TeamMatchToken: z.ZodString;
QueueID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
ProvisioningFlowID: z.ZodEnum<["Matchmaking", "CustomGame"]>;
IsRanked: z.ZodBoolean;
PhaseTimeRemainingNS: z.ZodNumber;
StepTimeRemainingNS: z.ZodNumber;
altModesFlagADA: z.ZodBoolean;
TournamentMetadata: z.ZodNull;
RosterMetadata: z.ZodNull;
}, "strip", z.ZodTypeAny, {
CastedVotes?: unknown;
ID: string;
MUCName: string;
Version: number;
GamePodID: string;
Mode: string;
QueueID: string;
Teams: {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}[];
AllyTeam: {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
} | null;
EnemyTeam: {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
} | null;
ObserverSubjects: unknown[];
MatchCoaches: unknown[];
EnemyTeamSize: number;
EnemyTeamLockCount: number;
PregameState: "character_select_active" | "provisioned";
LastUpdated: Date;
MapID: string;
MapSelectPool: unknown[];
BannedMapIDs: unknown[];
MapSelectSteps: unknown[];
MapSelectStep: number;
Team1: string;
VoiceSessionID: string;
TeamMatchToken: string;
ProvisioningFlowID: "Matchmaking" | "CustomGame";
IsRanked: boolean;
PhaseTimeRemainingNS: number;
StepTimeRemainingNS: number;
altModesFlagADA: boolean;
TournamentMetadata: null;
RosterMetadata: null;
}, {
CastedVotes?: unknown;
ID: string;
MUCName: string;
Version: number;
GamePodID: string;
Mode: string;
QueueID: string;
Teams: {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
}[];
AllyTeam: {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
} | null;
EnemyTeam: {
TeamID: string;
Players: {
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: {
SeasonID: string;
NumberOfWins: number;
WinsByTier: null;
Rank: number;
LeaderboardRank: number;
};
CharacterID: string;
CharacterSelectionState: "" | "selected" | "locked";
PregamePlayerState: "joined";
IsCaptain: boolean;
}[];
} | null;
ObserverSubjects: unknown[];
MatchCoaches: unknown[];
EnemyTeamSize: number;
EnemyTeamLockCount: number;
PregameState: "character_select_active" | "provisioned";
LastUpdated: string;
MapID: string;
MapSelectPool: unknown[];
BannedMapIDs: unknown[];
MapSelectSteps: unknown[];
MapSelectStep: number;
Team1: string;
VoiceSessionID: string;
TeamMatchToken: string;
ProvisioningFlowID: "Matchmaking" | "CustomGame";
IsRanked: boolean;
PhaseTimeRemainingNS: number;
StepTimeRemainingNS: number;
altModesFlagADA: boolean;
TournamentMetadata: null;
RosterMetadata: null;
}>;
};
};
export type PregameMatchResponse = z.infer<typeof pregameMatchEndpoint.responses['200']>;