valorant-api-types/dist/endpoints/pvp/Leaderboard.d.ts

A collection of documented endpoints and return types for the unofficial Valorant API

import { z } from 'zod';
export declare const leaderboardEndpoint: {
    readonly name: "Leaderboard";
    readonly description: "Get the leaderboard for a given season";
    readonly queryName: "MMR_FetchLeaderboard";
    readonly category: "PVP Endpoints";
    readonly type: "pd";
    readonly suffix: "mmr/v1/leaderboards/affinity/na/queue/competitive/season/{season id}";
    readonly query: Map<string, z.ZodType<any, z.ZodTypeDef, any>>;
    readonly variables: Map<string, z.ZodString>;
    readonly riotRequirements: {
        readonly token: true;
        readonly entitlement: true;
        readonly clientPlatform: true;
        readonly clientVersion: true;
    };
    readonly responses: {
        readonly '200': z.ZodObject<{
            Deployment: z.ZodString;
            QueueID: z.ZodString;
            SeasonID: z.ZodString;
            Players: z.ZodArray<z.ZodObject<{
                PlayerCardID: z.ZodString;
                TitleID: z.ZodString;
                IsBanned: z.ZodBoolean;
                IsAnonymized: z.ZodBoolean;
                puuid: z.ZodString;
                gameName: z.ZodString;
                tagLine: z.ZodString;
                leaderboardRank: z.ZodNumber;
                rankedRating: z.ZodNumber;
                numberOfWins: z.ZodNumber;
                competitiveTier: z.ZodNumber;
            }, "strip", z.ZodTypeAny, {
                PlayerCardID: string;
                puuid: string;
                gameName: string;
                tagLine: string;
                competitiveTier: number;
                TitleID: string;
                IsBanned: boolean;
                IsAnonymized: boolean;
                leaderboardRank: number;
                rankedRating: number;
                numberOfWins: number;
            }, {
                PlayerCardID: string;
                puuid: string;
                gameName: string;
                tagLine: string;
                competitiveTier: number;
                TitleID: string;
                IsBanned: boolean;
                IsAnonymized: boolean;
                leaderboardRank: number;
                rankedRating: number;
                numberOfWins: number;
            }>, "many">;
            totalPlayers: z.ZodNumber;
            immortalStartingPage: z.ZodNumber;
            immortalStartingIndex: z.ZodNumber;
            topTierRRThreshold: z.ZodNumber;
            tierDetails: z.ZodRecord<z.ZodString, z.ZodObject<{
                rankedRatingThreshold: z.ZodNumber;
                startingPage: z.ZodNumber;
                startingIndex: z.ZodNumber;
            }, "strip", z.ZodTypeAny, {
                rankedRatingThreshold: number;
                startingPage: number;
                startingIndex: number;
            }, {
                rankedRatingThreshold: number;
                startingPage: number;
                startingIndex: number;
            }>>;
            startIndex: z.ZodNumber;
            query: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            QueueID: string;
            Players: {
                PlayerCardID: string;
                puuid: string;
                gameName: string;
                tagLine: string;
                competitiveTier: number;
                TitleID: string;
                IsBanned: boolean;
                IsAnonymized: boolean;
                leaderboardRank: number;
                rankedRating: number;
                numberOfWins: number;
            }[];
            SeasonID: string;
            startIndex: number;
            query: string;
            Deployment: string;
            totalPlayers: number;
            immortalStartingPage: number;
            immortalStartingIndex: number;
            topTierRRThreshold: number;
            tierDetails: Record<string, {
                rankedRatingThreshold: number;
                startingPage: number;
                startingIndex: number;
            }>;
        }, {
            QueueID: string;
            Players: {
                PlayerCardID: string;
                puuid: string;
                gameName: string;
                tagLine: string;
                competitiveTier: number;
                TitleID: string;
                IsBanned: boolean;
                IsAnonymized: boolean;
                leaderboardRank: number;
                rankedRating: number;
                numberOfWins: number;
            }[];
            SeasonID: string;
            startIndex: number;
            query: string;
            Deployment: string;
            totalPlayers: number;
            immortalStartingPage: number;
            immortalStartingIndex: number;
            topTierRRThreshold: number;
            tierDetails: Record<string, {
                rankedRatingThreshold: number;
                startingPage: number;
                startingIndex: number;
            }>;
        }>;
    };
};
export type LeaderboardResponse = z.input<typeof leaderboardEndpoint.responses['200']>;