Skip to main content

an api client for the online Multiplayer game WarEra written in python (unfinished)

Project description

WarEraAPI (unofficial)

An API client for the online multiplayer game WarEra written in Python.

Overview

WarEraAPI is an asynchronous Python client that provides access to (most of) the WarEra game API. It allows developers to interact with various aspects of the game including companies, battles, users, articles, MUs, and more.

Features

  • Comprehensive API Coverage: Access to most WarEra API endpoints
  • Asynchronous Support: Built with aiohttp for efficient async operations
  • Type Safety: Full type hints and data models for all API responses
  • Pagination Support: Built-in pagination handling for large datasets
  • Rate Limiting Support: yeah, thats it

Installation

pip install WarEraAPI

Requirements

  • Python 3.10+
  • aiohttp>=3.13.4

Quick Start

import asyncio
from WarEraAPI import WarEraClient

async def main():
    # Initialize client with API key (optional)
    client = WarEraClient(api_key="your_api_key_here")
    
    # Get user information
    user = await client.get_user(userId="user_id_here")
    print(user)
    
    # Get 3 active battles
    battles = await client.get_battles(limit=3, isActive=True)
    print(battles)
    
    # Get company information
    company = await client.get_company(companyId="company_id_here")
    print(company)

# Run the async function
asyncio.run(main())

Check Documentation!

Development

This project is currently in development and provides access to most of the WarEra API. The full API is not fully documented in the current time so further developments intend to support as much from the api as possible

Currently Unsupported Documented Endpoints

  • battleRanking
    • getRanking
  • itemOffer
    • getById
  • gameConfig
    • getGameConfig

Roadmap

  • adding use examples
  • documenting types
  • implementing the unsupported endpoints
  • add more abstract/QOL methods

License

This project is open source and available under the MIT License.

Contact

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wareraapi-0.2.12.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wareraapi-0.2.12-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file wareraapi-0.2.12.tar.gz.

File metadata

  • Download URL: wareraapi-0.2.12.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for wareraapi-0.2.12.tar.gz
Algorithm Hash digest
SHA256 ad5aa35afbf620b21a2e9b1bda81dcf029cfef1aef2e84d4f8f6a3d1b3618d85
MD5 21607c29b25355d8e30b1a71f74b9e8b
BLAKE2b-256 cace349c24fd1be2c9d47bc80b520e9e1ddd4af777b5ee542d121470eb8e4b77

See more details on using hashes here.

File details

Details for the file wareraapi-0.2.12-py3-none-any.whl.

File metadata

  • Download URL: wareraapi-0.2.12-py3-none-any.whl
  • Upload date:
  • Size: 29.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for wareraapi-0.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 f8ae7ca49fd95cad9e871b2298caca32d159cbadbc93242bd92a8f72ed1e38df
MD5 90e37f6cbee7ea076d4a073e4030fd89
BLAKE2b-256 b96f374e87ee66cf166e6ea701fb78e698dcaa0894c3f81f99f3afdaff62fd3b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page