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.10.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.10-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wareraapi-0.2.10.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.10.tar.gz
Algorithm Hash digest
SHA256 ceef1e64c66c174fad2d95565425414138948d918115c05d3b93d1680a363ecf
MD5 c3e74921e469d36abdc2b554ee7ae234
BLAKE2b-256 db2ca607528752eee58936115f1254cdec0e63d64513b2151c2cf03785618bcd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wareraapi-0.2.10-py3-none-any.whl
  • Upload date:
  • Size: 29.3 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 45c178df1303a77c6d010a0ff79eea78d1be9742e38bb7e2b4ff81cfa828f90f
MD5 10e5ea4bdf7fc99fd28a899d1cb9a4a7
BLAKE2b-256 4b51ffe1b06a82a9e3b6afdb875086ded9b35ab10bac5f45e47a20e7e32bfeb5

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