Repository files navigation

Modern API wrapper for HoYoLAB & Miyoushe(米游社) API built on asyncio and pydantic.

genshin.py was originally started byashleney, due to lack of time to maintain, it has been transferred toseriaati.

Downloading the package fromhttps://github.com/ashleney/genshin.py will still work because GitHub automatically redirects to the new repository.

• Documentation
• API Reference
• Source Code
• Discord Server

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 English 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.

Note: This library is a successor togenshinstats - an unofficial wrapper for the Genshin Impact api.

• Python 3.9+
• aiohttp 3.0+
• Pydantic 2.0+
• tenacity 9.0+

To install the stable version:

pip install genshin

You can also install the latest development version from GitHub:

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

A new release is made every 2 weeks.

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

importasyncioimportgenshinasyncdefmain():cookies= {"ltuid":119480035,"ltoken":"cnF7TiZqHAAvYqgCBoSPx5EjwezOh1ZHoqSHf7dT"}client=genshin.Client(cookies,uid=710785423)user=awaitclient.get_genshin_user()print(f"User has a total of{user.stats.characters} characters")asyncio.run(main())

Any kind of contribution is welcome.Please readCONTRIBUTING.md to see what you need to do to make a contribution.

Genshin.py has been actively developed since2021-02-06. Please report any potential copyright violations to the owner throughdiscord.