aoe2netapi-wrapper 2.0.0

A simple and basic Python 3 API wrapper for the https://aoe2.net/#api API.

aoe2net-api-wrapper

A simple and basic Python 3 https://aoe2.net/ API wrapper for sending GET requests.

See the documentation of the API wrapper here on GitHub: section 'Documentation'.

See https://aoe2.net/#api and https://aoe2.net/#nightbot for the aoe2.net API (documentation) directly.

Requirements:

• requests >= 2.20.0
• dataclasses-json == 0.5.7
• Python 3.7+ required

Installation

Available on PyPi

pip install aoe2netapi-wrapper

Example usage

from aoe2netapi import API, Nightbot
from aoe2netapi.constants import LeaderboardId, EventLeaderboardId
from aoe2netapi.models import Leaderboard

# API class
api = API()
leaderboard: Leaderboard = api.get_leaderboard(leaderboard_id=LeaderboardId.AOE_TWO_RM, count=100)
print(leaderboard)
# Leaderboard<total = 43055, leaderboard_id = 3, start = 1, count = 100, players = [...],
#             game="aoe2de", is_event_leaderboard=False

for player in leaderboard.players:  # player is of type 'LeaderboardPlayer'
  print(player.rank, player.name, player.rating, player.highest_rating, ...)

# Nighbot class
nightbot = Nightbot()
rating_history: str = nightbot.get_current_or_last_match(leaderboard_id=LeaderboardId.AOE_TWO_RM, search="GL.TheViper")
print(rating_history)
# GL.TheViper (2688) Rank #4, has played 1,542 games with a 65% winrate, -1 streak, and 4 drops

Documentation

See the documentation on the provided functions here on GitHub: documentation page.

For the documentation for previous versions, see the documentation page here: documentation page.

Changelog

See the changelog here on GitHub: changelog page.

License

MIT License. See LICENSE.