albion-api-wrapper
Version:
A wrapper library for Albion Online API.
50 lines (49 loc) • 1.79 kB
TypeScript
type Region = "americas" | "europe" | "asia";
declare class AlbionAPI {
private client;
constructor(region?: Region);
searchPlayers(searchTerm: string): Promise<any>;
getPlayerInfo(playerId: string): Promise<any>;
getPlayerKills(playerId: string): Promise<any>;
getGuildInfo(guildId: string): Promise<any>;
getPlayerDeaths(playerId: string): Promise<any>;
getPlayerStatistics(params: {
range: "week" | "month";
limit: number;
offset: number;
type: "PvE" | "Gathering";
subtype?: "All" | "Fiber" | "Hide" | "Ore" | "Rock" | "Wood";
region?: "Total" | "Royal" | "Outlands" | "Hellgate";
guildId?: string;
allianceId?: string;
}): Promise<any>;
getGuildMembers(guildId: string): Promise<any>;
getGuildData(guildId: string): Promise<any>;
getGuildTopKills(guildId: string, params: {
range: "day" | "week" | "month";
limit: number;
offset: number;
region?: "Total" | "Royal" | "Outlands" | "Hellgate";
}): Promise<any>;
getAllianceInfo(allianceId: string): Promise<any>;
getBattles(params: {
range: "day" | "week" | "month";
limit: number;
offset: number;
sort: "totalFame" | "totalKills" | "recent";
}): Promise<any>;
getBattleInfo(battleId: string): Promise<any>;
getItemIcon(itemId: string): Promise<any>;
getItemData(itemId: string): Promise<any>;
getPlayerFame(params: {
range: "week" | "month" | "lastWeek" | "lastMonth";
limit: number;
offset: number;
}): Promise<any>;
getGuildFame(params: {
range: "week" | "month" | "lastWeek" | "lastMonth";
limit: number;
offset: number;
}): Promise<any>;
}
export default AlbionAPI;