ambr-py

Quick links

Developing something for Hoyoverse games? Here's a collection of Python async API wrappers for Hoyoverse games made by me:

• enka.py is an Enka Network API wrapper for fetching in-game showcase.
• yatta.py is a Project Yatta API wrapper for fetching Honkai Star Rail game data.
• ambr.py is a Project Ambr API wrapper for fetching Genshin Impact game data.
• hakushin.py is a Hakushin API wrapper for fetching Genshin Impact and Honkai Star Rail beta game data.

Introduction

ambr-py is an async API wrapper for Project Ambr written in Python.
Project Ambr is a beautiful website that displays Genshin Impact game data.

Note: I am not the developer of Project Ambr.

Features

• Fully typed.
• Fully asynchronous by using aiofiles, aiohttp, and asyncio, suitable for Discord bots.
• Provides direct icon URLs.
• Supports Python 3.11+.
• Supports all game languages.
• Supports persistent caching using SQLite.
• Supports Pydantic V2, this also means full autocomplete support.

Installation

# poetry
poetry add ambr-py

# pip
pip install ambr-py

Quick Example

import ambr
import asyncio

async def main() -> None:
    async with ambr.AmbrAPI(ambr.Language.CHT) as client:
        await client.fetch_characters()

asyncio.run(main())

Getting Started

Read the wiki to learn more about on how to use this wrapper.

Questions, Issues, Contributions

For questions, you can contact me on Discord or open an issue.
To report issues with this wrapper, open an issue.
To contribute, fork this repo and submit a pull request.