genshin.py
Modern API wrapper for HoYoLAB & Miyoushe(米游社) API built on asyncio and pydantic.
Project Transferred
genshin.py was originally started by ashleney, due to lack of time to maintain, it has been transferred to seriaati.
Downloading the package from https://github.com/ashleney/genshin.py will still work because GitHub automatically redirects to the new repository.
Useful Links
Introduction
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 to genshinstats - an unofficial wrapper for the Genshin Impact api.
Requirements
- Python 3.9+
- aiohttp 3.0+
- Pydantic 2.0+
- tenacity 9.0+
Installation
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 month.
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, uid=710785423)
user = await client.get_genshin_user()
print(f"User has a total of {user.stats.characters} characters")
asyncio.run(main())
Contributing
Any kind of contribution is welcome. Please read CONTRIBUTING.md to see what you need to do to make a contribution.
License
Genshin.py has been actively developed since 2021-02-06. Please report any potential copyright violations to the owner through discord.
Release files for genshin 1.7.31
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| genshin-1.7.31.tar.gz | 140.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| genshin-1.7.31-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 339.4 kB
Release files / genshin-1.7.31.tar.gz
| Download URL | genshin-1.7.31.tar.gz |
|---|---|
| Size | 140.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
26fd56747332ed27a3f047d76a00cb925c4f3deb39d45af142c45627e12b7d14
|
|
BLAKE2b-256 checksum How to use checksums |
d107db4c10458173e121b99a19848bf847d4634362f8bb12fd02d6e1e1e49b6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / genshin-1.7.31-py3-none-any.whl
| Download URL | genshin-1.7.31-py3-none-any.whl |
|---|---|
| Size | 198.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0ad8384629f082b8079119224c2877ae4ee2688af0cb067f8f27b24c81ce9213
|
|
BLAKE2b-256 checksum How to use checksums |
214f0bb892163f5bc5635cfb0fbc1522dc805020f180fdaf6707e884d2ad7be1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
