valorant-api-types
Version:
A collection of documented endpoints and return types for the unofficial Valorant API
244 lines (243 loc) • 9.28 kB
TypeScript
import { z } from 'zod';
export declare const currentGameMatchEndpoint: {
readonly name: "Current Game Match";
readonly description: "Get the current game match info";
readonly queryName: "CoreGame_FetchMatch";
readonly category: "Current Game Endpoints";
readonly type: "glz";
readonly suffix: "core-game/v1/matches/{current game match id}";
readonly riotRequirements: {
readonly token: true;
readonly entitlement: true;
readonly clientPlatform: true;
readonly clientVersion: true;
};
readonly responses: {
readonly '200': z.ZodObject<{
MatchID: z.ZodString;
Version: z.ZodNumber;
State: z.ZodEnum<["IN_PROGRESS"]>;
MapID: z.ZodString;
ModeID: z.ZodString;
ProvisioningFlow: z.ZodEnum<["Matchmaking", "CustomGame"]>;
GamePodID: z.ZodString;
AllMUCName: z.ZodString;
TeamMUCName: z.ZodString;
TeamVoiceID: z.ZodString;
TeamMatchToken: z.ZodString;
IsReconnectable: z.ZodBoolean;
ConnectionDetails: z.ZodObject<{
GameServerHosts: z.ZodArray<z.ZodString, "many">;
GameServerHost: z.ZodString;
GameServerPort: z.ZodNumber;
GameServerObfuscatedIP: z.ZodNumber;
GameClientHash: z.ZodNumber;
PlayerKey: z.ZodString;
}, "strip", z.ZodTypeAny, {
GameServerHosts: string[];
GameServerHost: string;
GameServerPort: number;
GameServerObfuscatedIP: number;
GameClientHash: number;
PlayerKey: string;
}, {
GameServerHosts: string[];
GameServerHost: string;
GameServerPort: number;
GameServerObfuscatedIP: number;
GameClientHash: number;
PlayerKey: string;
}>;
PostGameDetails: z.ZodNull;
Players: z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
TeamID: z.ZodUnion<[z.ZodEnum<["Blue", "Red"]>, z.ZodString]>;
CharacterID: z.ZodString;
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;
}>;
IsCoach: z.ZodBoolean;
IsAssociated: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
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;
};
TeamID: string;
CharacterID: string;
IsCoach: boolean;
IsAssociated: boolean;
}, {
Subject: string;
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;
};
TeamID: string;
CharacterID: string;
IsCoach: boolean;
IsAssociated: boolean;
}>, "many">;
MatchmakingData: z.ZodNull;
}, "strip", z.ZodTypeAny, {
Version: number;
GamePodID: string;
State: "IN_PROGRESS";
MatchmakingData: null;
Players: {
Subject: string;
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;
};
TeamID: string;
CharacterID: string;
IsCoach: boolean;
IsAssociated: boolean;
}[];
MapID: string;
TeamMatchToken: string;
MatchID: string;
ModeID: string;
ProvisioningFlow: "Matchmaking" | "CustomGame";
AllMUCName: string;
TeamMUCName: string;
TeamVoiceID: string;
IsReconnectable: boolean;
ConnectionDetails: {
GameServerHosts: string[];
GameServerHost: string;
GameServerPort: number;
GameServerObfuscatedIP: number;
GameClientHash: number;
PlayerKey: string;
};
PostGameDetails: null;
}, {
Version: number;
GamePodID: string;
State: "IN_PROGRESS";
MatchmakingData: null;
Players: {
Subject: string;
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;
};
TeamID: string;
CharacterID: string;
IsCoach: boolean;
IsAssociated: boolean;
}[];
MapID: string;
TeamMatchToken: string;
MatchID: string;
ModeID: string;
ProvisioningFlow: "Matchmaking" | "CustomGame";
AllMUCName: string;
TeamMUCName: string;
TeamVoiceID: string;
IsReconnectable: boolean;
ConnectionDetails: {
GameServerHosts: string[];
GameServerHost: string;
GameServerPort: number;
GameServerObfuscatedIP: number;
GameClientHash: number;
PlayerKey: string;
};
PostGameDetails: null;
}>;
};
};
export type CurrentGameMatchResponse = z.input<typeof currentGameMatchEndpoint.responses['200']>;