Skip to content

Overview

Modern API wrapper for Genshin Impact & Honkai Impact 3rd built on asyncio and pydantic.

The primary focus of genshin.py is convenience. The entire project is fully type-hinted and abstracts a large amount of the api to be easier to use.

Key features:

  • All data is in the form of Pydantic Models which means full autocompletion and linter support.
  • Requests are significantly faster thanks to proper usage of asyncio.
  • Chinese and Engrish names returned by the API are renamed to simpler English fields.
  • Supports the majority of the popular endpoints.
  • Cleanly integrates with frameworks like FastAPI out of the box.

Installation

From PyPI:

pip install genshin

From github:

pip install git+https://github.com/thesadru/genshin.py

Requirements:

  • Python 3.9+
  • aiohttp
  • Pydantic

Example

A very simple example of how genshin.py would be used:

import asyncio
import genshin

async def main():
    cookies = {"ltuid": 119480035, "ltoken": "cnF7TiZqHAAvYqgCBoSPx5EjwezOh1ZHoqSHf7dT"}
    client = genshin.Client(cookies)

    data = await client.get_genshin_user(710785423)
    print(f"User has a total of {len(data.stats.characters)} characters")

asyncio.run(main())

The API reference has been moved to pdoc.

Genshin.py has been actively developed since 2021-02-06. Please report any potential copyright violations to the owner through discord.