@meibot/unofficial-valorant-api

import type { APIResponse, Locale, Mode, Rank, Region, Season, ValorantMap } from "./types/general"; import type { RawCompetitiveUpdatesResponse } from "./types/raw/competitive-updates"; import type { RawMatchDetailsResponse } from "./types/raw/match-details"; import type { RawMatchHistoryResponse } from "./types/raw/match-history"; import type { RawMMRResponse } from "./types/raw/mmr"; import type { V1AccountResponse } from "./types/v1-account"; import type { V1ContentResponse } from "./types/v1-content"; import type { V1CrosshairResponse } from "./types/v1-crosshair"; import { v1EsportsSchedule } from "./types/v1-esports-schedule"; import { V1LifetimeMatchesResponse } from "./types/v1-lifetime-matches"; import type { V1StatusResponse } from "./types/v1-status"; import type { V1VersionResponse } from "./types/v1-version"; import type { V1WebsiteResponse } from "./types/v1-website"; import type { V2MatchResponse } from "./types/v2-match"; import type { V1MMRHistoryResponse } from "./types/v1-mmr-history"; import type { V3MatchesResponse } from "./types/v3-matches"; import { LeaderboardResponse, MMRResponse, RawResponse, StoreFeaturedResponse, StoreOffersResponse } from "./types/versions.js"; export default class { private token?; /** * Images for every Rank * @remarks * You must call {@link initUtils} before using this! */ rankImages?: { [key in Rank]: { large: string; small: string; triangleUp: string; triangleDown: string; }; }; /** * Images for every Valorant map * @remarks * You must call {@link initUtils} before using this! */ mapImages?: { [key in ValorantMap | "The Range"]: { splash: string; minimap: string; landscape: string; }; }; /** * Create a new instance of the main API. All API calls are in this class * @example * Create a new instance * ```js * import _VAPI from "unofficial-valorant-api" * const VAPI = new _VAPI("my super secret token") * ``` * @param token - (optional) The token, if you have one. Get one from the Discord server ({@link https://discord.gg/wXNMnqzvAD}) */ constructor(token?: string); /** * Creates {@link default.rankImages} and {@link default.mapImages} by pulling the images from {@link https://valorant-api.com} * @remarks * Must be called before using {@link default.rankImages} and {@link default.mapImages} */ initUtils(): Promise<void>; /** * @internal * Parses the body of an axios response */ private parseBody; /** * @internal * Main function to fetch from the API * @typeParam dataType - The type of the response * @param url - URl to fetch. Appended to the base url and automatically encoded * @param searchParams - Any extra search params. Empty values will be filtered out * @param config - Override the default axios config with custom params * @returns Formatted response */ private fetch; /** * @internal * Make sure each key has a non empty value * @param input - Object to check for non empty values * @throws TypeError - Only if there is a empty value to a key */ private validateArgs; /** * Get an image of a valorant crosshair by its code * @example * Load and write a crosshair to crosshair.png * ```js * import { writeFileSync } from "fs" * * const crosshair = await default.getCrosshair("0;s;1;P;c;5;o;1;d;1;z;3;0b;0;1b;0;S;c;4;o;1") * writeFileSync("crosshair.png", crosshair.data) * ``` * @param args.code - Valorant crosshair code * @param args.size - (optional) Image size (default: `1024`) * @returns The image of the crosshair as a {@link https://nodejs.org/api/buffer.html Buffer} */ getCrosshair({ code, size }: { code: string; size?: number; }): Promise<APIResponse<V1CrosshairResponse>>; /** * Get all announcements from the valorant website of a country * @param args.countryCode - Country code of website * @returns List of announcements from the valorant website */ getAnnouncements({ countryCode, }: { countryCode: "en-us" | "en-gb" | "de-de" | "es-es" | "es-mx" | "fr-fr" | "it-it" | "ja-jp" | "ko-kr" | "pt-br" | "ru-ru" | "tr-tr" | "vi-vn"; }): Promise<APIResponse<V1WebsiteResponse>>; /** * Get all announcements from the valorant website of a country * @param args.countryCode - Country code of website * @returns List of announcements from the valorant website * @depreciated Use {@link default.getAnnouncements} instead */ getWebsite({ countryCode, category, }: { countryCode: "en-us" | "en-gb" | "de-de" | "es-es" | "es-mx" | "fr-fr" | "it-it" | "ja-jp" | "ko-kr" | "pt-br" | "ru-ru" | "tr-tr" | "vi-vn"; category?: "game_updates" | "dev" | "esports" | "announcements" | "patch_notes"; }): Promise<APIResponse<V1WebsiteResponse>>; /** * Get information about valorant in a region, such as the client version, branch, and server version * @param args.region - Region of valorant to get info about * @returns Information about a regions valorant */ getVersion({ region }: { region: Region; }): Promise<APIResponse<V1VersionResponse>>; /** * Get all of the featured items in the current valorant store * @returns Featured items in the current valorant store */ getFeaturedItems<T extends "v1" | "v2">({ version }?: { version?: T; }): Promise<APIResponse<StoreFeaturedResponse<T>>>; /** * Get a list of all the prices of every skin in the game * @returns List of skin prices */ getOffers<T extends "v1" | "v2">({ version }?: { version?: T; }): Promise<APIResponse<StoreOffersResponse<T>>>; /** * Will get information about the current maintenances and incidents about a region * @param args.region - Region to get info about * @returns Info about undergoing maintenances and incidents in a region of valorant */ getStatus({ region }: { region: Region; }): Promise<APIResponse<V1StatusResponse>>; /** * Gets raw data for a match from the valorant API. (Not formatted, use only if you know what you are doing) * @see {@link default.getMatch} for an easier response to use * @param args.matchID - The match ID to get details about * @param args.region - Region of the match * @param args.queries - Extra queries. See {@link https://github.com/techchrism/valorant-api-docs/blob/trunk/docs/PVP%20Endpoints/GET%20MatchDetails_FetchMatchDetails.md documentation} * @returns Information about the match */ getRawMatchDetails({ matchID, region, queries }: { matchID: string; region: Region; queries?: any; }): Promise<APIResponse<RawMatchDetailsResponse>>; /** * Gets raw data for a players match history from the valorant API. (Not formatted, use only if you know what you are doing) * @see {@link default.getMatches} for an easier response to use * @param args.puuid - The match ID to get details about * @param args.region - Region of the player * @param args.queries - Extra queries. See {@link https://github.com/techchrism/valorant-api-docs/blob/trunk/docs/PVP%20Endpoints/GET%20MatchHistory_FetchMatchHistory.md documentation} * @returns Information about the players match history */ getRawMatchHistory({ puuid, region, queries }: { puuid: string; region: Region; queries?: any; }): Promise<APIResponse<RawMatchHistoryResponse>>; /** * Gets raw data for a players competitive updates (rr changes) from the valorant API. **(Not formatted, use only if you know what you are doing)** * @see {@link default.getMMRHistory} for an easier response to use * @param args.puuid - The match ID to get details about * @param args.region - Region of the player * @param args.queries - Extra queries. See {@link https://github.com/techchrism/valorant-api-docs/blob/trunk/docs/PVP%20Endpoints/GET%20MMR_FetchCompetitiveUpdates.md documentation} * @returns Information about the players rr history */ getRawCompetitiveUpdates({ puuid, region, queries }: { puuid: string; region: Region; queries?: any; }): Promise<APIResponse<RawCompetitiveUpdatesResponse>>; /** * Gets raw data for a players mmr from the valorant API. **(Not formatted, use only if you know what you are doing)** * @see {@link default.getMMR} for an easier response to use * @param args.puuid - The match ID to get details about * @param args.region - Region of the player * @param args.queries - Extra queries. See {@link https://github.com/techchrism/valorant-api-docs/blob/trunk/docs/PVP%20Endpoints/GET%20MMR_FetchPlayer.md documentation} * @returns Information about the players mmr */ getRawMMR({ puuid, region, queries }: { puuid: string; region: Region; queries?: any; }): Promise<APIResponse<RawMMRResponse>>; /** * Gets raw data from the valorant API. **(Not formatted, use only if you know what you are doing)** * @param args.type - Type of data to return * @param args.value - A players puuid if type is `mmr` or `competitiveupdates`, else a match id * @param args.region - Region of the player or match * @param args.queries * @returns Either match details, a users patch history, a users mmr, or a users past rr changes * @depreciated Use {@link default.getRawCompetitiveUpdates} {@link default.getRawMatchDetails} {@link default.getRawMatchHistory} {@link default.getRawMMR} instead */ getRawData<T extends "matchdetails" | "matchhistory" | "mmr" | "competitiveupdates">({ type, value, region, queries, }: { type: T; value: string; region: Region; queries: any; }): Promise<APIResponse<RawResponse<T>>>; /** * Get a list of rr changes of a player by their Riot ID * @param args.name - The Riot ID username of the player * @param args.tag - The Riot tag username of the player * @param args.region - The players region * @return List of rr changes (recent competitive games) */ getMMRHistory({ name, tag, region }: { name: string; tag: string; region: Region; }): Promise<APIResponse<V1MMRHistoryResponse>>; /** * Get a list of rr changes of a player by their PUUID * @param args.puuid - The PUUID of the player * @param args.region - The players region * @return List of rr changes (recent competitive games) */ getMMRHistoryByPUUID({ puuid, region }: { puuid: string; region: Region; }): Promise<APIResponse<V1MMRHistoryResponse>>; /** * Get information about a match * @param args.matchID - The matchs ID * @returns Information about the match */ getMatch({ matchID }: { matchID: string; }): Promise<APIResponse<V2MatchResponse>>; /** * Get the leaderboard of a region * @remarks * In order for player filtering to work, they must be Immortal or higher * @param args.region - Region to get leaderboard from * @param args.version - Can be `v1` or `v2`. Note: V2 does not support filters! * @param args.start - (optional) Get 1000 leaderboard players starting from the given start value * @param args.end - (optional) Limit the amount of leaderboard players returned * @param args.riotID - (optional) Search for a specific player by their Riot ID * @param args.riotID.name - The Riot IDs username * @param args.riotID.tag - The Riot IDs tag * @param args.puuid - (optional) Search for a specific player by their PUUID * @param args.season - (optional) Get leaderboard from a specific season * @returns Descending order of the highest ranked players. (Immortal and up) * @throws TypeError - If both a riotID and puuid are supplied */ getLeaderboard<T extends "v1" | "v2">({ version, region, start, end, riotID, puuid, season, }: { version?: T; region: Region; start?: number; end?: number; riotID?: { name: string; tag: string; }; puuid?: string; season?: Season; }): Promise<APIResponse<LeaderboardResponse<T>>>; /** * Get all translations for every character, skin, map, ability, spray, charm, player card, player title, and more in the game * @param args.locale - If this is set, instead of all translations, it will return just translations for this language */ getTranslations({ locale }?: { locale?: Locale; }): Promise<APIResponse<V1ContentResponse>>; /** * Get all translations for every character, skin, map, ability, spray, charm, player card, player title, and more in the game * @param args.locale - If this is set, instead of all translations, it will return just translations for this language * @depreciated Use the new {@link default.getTranslations} instead */ getContent({ locale }?: { locale?: Locale; }): Promise<APIResponse<V1ContentResponse>>; /** * Gets general info about a players rank by their Riot ID * @remarks * **Returns:** * - Current rank and info about their rank * - RR change on their last game * - Their PUUID * - Their peak rank from every season * @param args.name - The Riot ID username of the player * @param args.tag - The Riot ID tag of the player * @param args.region - The region of the player * @param args.seasonFilter - (optional) Filter results based on episode and act * @param args.version - (optional) Change endpoint version * @param args.filter - (optional) Same as seasonFilter. Only here for backwards compatibility * @returns Information about a players mmr/rank * @throws TypeError - If both filter and seasonFilter are set */ getMMR<T extends "v1" | "v2">({ name, tag, region, seasonFilter, version, }: { name: string; tag: string; region: Region; seasonFilter?: Season; version?: T; }): Promise<APIResponse<MMRResponse<T>>>; /** * Gets general info about a players rank by their PUUID * @remarks * **Returns:** * - Current rank and info about their rank * - RR change on their last game * - Their PUUID * - Their peak rank from every season * @param args.puuid - The PUUID of the player * @param args.region - The region of the player * @param args.seasonFilter - (optional) Filter results based on episode and act * @param args.version - (optional) Change endpoint version * @param args.filter - (optional) Same as seasonFilter. Only here for backwards compatibility * @returns Information about a players mmr/rank * @throws TypeError - If both filter and seasonFilter are set */ getMMRByPUUID<T extends "v1" | "v2">({ puuid, region, seasonFilter, version, }: { puuid: string; region: Region; seasonFilter?: Season; version?: T; }): Promise<APIResponse<MMRResponse<T>>>; /** * Gets the most recent 5 matches by a players Riot ID * @remarks * **Returns:** * - Info about most recent 5 matches including: * - Metadata info about the match such as length, time, map, score, etc * - Information about every player including their PUUID, Riot ID, kills, ability usage, etc * - Information about every round in the match such as plant/defuse info, etc * - Information about every kill in the game including killer, victim, assist, etc * @param args.name - The Riot ID username of the player * @param args.tag - The Riot ID tag of the player * @param args.region - The region of the player * @param args.gamemodeFilter - Filter results based on gamemode * @param args.mapFilter - Filter results based on map * @param args.size - Return a specific amount of matches (1-10) * @returns Info about a players last 5 matches * @throws TypeError - Only if the size parameter is set and not between 1-10 */ getMatches({ name, tag, region, gamemodeFilter, mapFilter, size, }: { name: string; tag: string; region: Region; gamemodeFilter?: Mode; mapFilter?: ValorantMap; size?: number; }): Promise<APIResponse<V3MatchesResponse>>; /** * Gets the most recent 5 matches by a players PUUID * @remarks * **Returns:** * - Info about most recent 5 matches including: * - Metadata info about the match such as length, time, map, score, etc * - Information about every player including their PUUID, Riot ID, kills, ability usage, etc * - Information about every round in the match such as plant/defuse info, etc * - Information about every kill in the game including killer, victim, assist, etc * @param args.puuid - The PUUID username of the player * @param args.region - The region of the player * @param args.gamemodeFilter - Filter results based on gamemode * @param args.mapFilter - Filter results based on map * @param args.size - Return a specific amount of matches (1-10) * @returns Info about a players last 5 matches * @throws TypeError - Only if the size parameter is set and not between 1-10 */ getMatchesByPUUID({ puuid, region, gamemodeFilter, mapFilter, size, }: { puuid: string; region: Region; gamemodeFilter?: Mode; mapFilter?: ValorantMap; size?: number; }): Promise<APIResponse<V3MatchesResponse>>; /** * Get general information about a player from their Riot ID * @remarks * **Returns:** * - Their PUUID * - Their region * - Their account level * - Their current card * @param args.name - The Riot ID username of the player * @param args.tag - The Riot ID tag of the player * @param args.force - Force data update? * @return General information on a players profile */ getAccount({ name, tag, force }: { name: string; tag: string; force?: boolean; }): Promise<APIResponse<V1AccountResponse>>; /** * Get general information about a player from their Riot ID * @remarks * **Returns:** * - Their PUUID * - Their region * - Their account level * - Their current card * @param args.puuid The PUUID of the player * @param args.force Force data update? * @return General information on a players profile */ getAccountByPUUID({ puuid, force }: { puuid: string; force?: boolean; }): Promise<APIResponse<V1AccountResponse>>; /** * Get all matches fetched matches from a player * @remarks * **Returns:** * - The most important metadata * - The most important stats * - The team results * @param args.name - The Riot ID username of the player * @param args.tag - The Riot ID tag of the player * @param args.region - The region of the player * @param args.gamemodeFilter - Filter results based on gamemode * @param args.mapFilter - Filter results based on map * @param args.page - Return a specific page of all matches (can only be used with the "size" params) * @param args.size - Return a specific amount of matches (can only be used with the "page" params) * @return All fetched matches from a player */ getLifetimeMatches({ name, tag, region, gamemodeFilter, mapFilter, page, size, }: { name: string; tag: string; region: Region; gamemodeFilter: Mode; mapFilter?: ValorantMap; page: number; size: number; }): Promise<APIResponse<V1LifetimeMatchesResponse>>; /** * Get all matches fetched matches from a player * @remarks * **Returns:** * - The most important metadata * - The most important stats * - The team results * @param args.puuid The PUUID of the player * @param args.region - The region of the player * @param args.gamemodeFilter - Filter results based on gamemode * @param args.mapFilter - Filter results based on map * @param args.page - Return a specific page of all matches (can only be used with the "size" params) * @param args.size - Return a specific amount of matches (can only be used with the "page" params) * @return All fetched matches from a player */ getLifetimeMatchesByPUUID({ puuid, region, gamemodeFilter, mapFilter, page, size, }: { puuid: string; region: Region; gamemodeFilter?: Mode; mapFilter?: ValorantMap; page?: number; size?: number; }): Promise<APIResponse<V1LifetimeMatchesResponse>>; /** * Get esports schedule data * @remarks * **Returns:** * - All scheduled esport games * - Games from: https://valorantesports.com/schedule * @param args.region - Filter for schedules games in this region * @param args.league - Filter for schedules games in this league * @return All scheduled esport games */ getEsportsSchedule({ region, league }: { region: string; league: string; }): Promise<APIResponse<v1EsportsSchedule>>; }