npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

albion-api-wrapper

v1.2.2

Published

A wrapper library for Albion Online API.

Downloads

105

Readme

# Albion API Wrapper

Uma biblioteca para facilitar o acesso à API do Albion Online. Esta biblioteca permite que você faça requisições simples para obter informações sobre jogadores, guildas, batalhas, itens e muito mais.

## Instalação

Para instalar a biblioteca, use o comando:

```bash
yarn add albion-api-wrapper

Ou, se estiver usando npm:

npm install albion-api-wrapper

Funcionalidades

A albion-api-wrapper fornece métodos simples para acessar os principais endpoints da API do Albion Online, como:

  • Pesquisar jogadores e guildas
  • Obter informações detalhadas sobre jogadores
  • Listar kills e mortes de jogadores
  • Obter estatísticas e dados de guildas
  • Consultar batalhas e itens
  • Acessar informações sobre alianças e fama de eventos

Regiões Suportadas

A biblioteca suporta três regiões:

  • americas: https://gameinfo.albiononline.com/api/gameinfo/
  • europe: https://gameinfo-ams.albiononline.com/api/gameinfo/
  • asia: https://gameinfo-sgp.albiononline.com/api/gameinfo/

Uso

Importação

Primeiro, importe a biblioteca em seu projeto:

import AlbionAPI from "albion-api-wrapper";

Exemplo de Uso

1. Criando uma Instância da API

Para criar uma instância da API, você pode especificar a região desejada:

const api = new AlbionAPI("europe");

Se nenhuma região for especificada, a API padrão será a região americas.

2. Pesquisando Jogadores

Use o método searchPlayers para pesquisar jogadores:

async function searchPlayers() {
  try {
    const players = await api.searchPlayers("playerName");
    console.log(players);
  } catch (error) {
    console.error("Erro ao buscar jogadores:", error);
  }
}

searchPlayers();

3. Obtendo Informações de um Jogador

Para obter informações detalhadas de um jogador, use o método getPlayerInfo:

async function fetchPlayerInfo() {
  try {
    const playerInfo = await api.getPlayerInfo("playerId");
    console.log(playerInfo);
  } catch (error) {
    console.error("Erro ao buscar informações do jogador:", error);
  }
}

fetchPlayerInfo();

4. Obtendo Últimos 10 Kills e Mortes de um Jogador

Para ver os últimos 10 registros de kills de um jogador, use getPlayerKills:

async function fetchPlayerKills() {
  try {
    const playerKills = await api.getPlayerKills("playerId");
    console.log(playerKills);
  } catch (error) {
    console.error("Erro ao buscar kills do jogador:", error);
  }
}

fetchPlayerKills();

Para ver os últimos 10 registros de mortes de um jogador, use getPlayerDeaths:

async function fetchPlayerDeaths() {
  try {
    const playerDeaths = await api.getPlayerDeaths("playerId");
    console.log(playerDeaths);
  } catch (error) {
    console.error("Erro ao buscar mortes do jogador:", error);
  }
}

fetchPlayerDeaths();

5. Obtendo Estatísticas de Jogadores

async function fetchPlayerStatistics() {
  try {
    const stats = await api.getPlayerStatistics({
      range: "week",
      limit: 10,
      offset: 0,
      type: "PvE"
    });
    console.log(stats);
  } catch (error) {
    console.error("Erro ao buscar estatísticas de jogadores:", error);
  }
}

fetchPlayerStatistics();

6. Obtendo Informações de uma Guilda

async function fetchGuildInfo() {
  try {
    const guildInfo = await api.getGuildInfo("guildId");
    console.log(guildInfo);
  } catch (error) {
    console.error("Erro ao buscar informações da guilda:", error);
  }
}

fetchGuildInfo();

7. Listando Membros de uma Guilda

async function fetchGuildMembers() {
  try {
    const members = await api.getGuildMembers("guildId");
    console.log(members);
  } catch (error) {
    console.error("Erro ao buscar membros da guilda:", error);
  }
}

fetchGuildMembers();

8. Obtendo Informações de uma Aliança

async function fetchAllianceInfo() {
  try {
    const alliance = await api.getAllianceInfo("allianceId");
    console.log(alliance);
  } catch (error) {
    console.error("Erro ao buscar informações da aliança:", error);
  }
}

fetchAllianceInfo();

9. Listando Batalhas

async function fetchBattles() {
  try {
    const battles = await api.getBattles({ range: "week", limit: 5, offset: 0, sort: "totalFame" });
    console.log(battles);
  } catch (error) {
    console.error("Erro ao buscar batalhas:", error);
  }
}

fetchBattles();

10. Obtendo Dados de um Item

async function fetchItemData() {
  try {
    const itemData = await api.getItemData("itemId");
    console.log(itemData);
  } catch (error) {
    console.error("Erro ao buscar dados do item:", error);
  }
}

fetchItemData();

Tratamento de Erros

Todos os métodos são assíncronos e retornam uma Promise. Certifique-se de usar try/catch para capturar qualquer erro durante as requisições.

Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests no repositório GitHub.