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.1.5.tar.gz (18.6 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.1.5-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wareraapi-0.1.5.tar.gz
Algorithm Hash digest
SHA256 8928a4db5ab182461c1e471806a021d8c9078b56ea70e67d519d12d5a6809eb1
MD5 8c0b1de2bf1239b56117c0a127a80e1d
BLAKE2b-256 766894bc816997e865a4e060fa59bf027db5380c0160790eccbcf4a2da4328a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wareraapi-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 28.5 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.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b00069ed5a910df0cfb68666fdfd8bb4ac2080da00920bfc007af47a954b5b5c
MD5 200474c375542332cc87f710258a4a7a
BLAKE2b-256 8a231f3a7a9fc772b4f2761afec6da1ca557e925cf7b2a7b9e9aa47fee73579e

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