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.15.tar.gz (19.5 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.15-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wareraapi-0.2.15.tar.gz
  • Upload date:
  • Size: 19.5 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.15.tar.gz
Algorithm Hash digest
SHA256 71ebb4b53eea922691d7025a3fc8c873401252ee6b138e58f00bf5990e904267
MD5 e244f7ca51a7998022fb4af5a49d3895
BLAKE2b-256 2f4c38d2bc113baa9eb48aad3c41798cf26c64f93dc758fa5db4a1af7e3669f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wareraapi-0.2.15-py3-none-any.whl
  • Upload date:
  • Size: 29.6 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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 8556900b5307df5d4f52c89b9a30f673e0964058e3744300387e540c684913af
MD5 a28195f376ffe0803791f4184be5a753
BLAKE2b-256 f642542e936239a30c9a1545a6ee290667feae36c1237d6460e1a91bda7dc5e6

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