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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file genshin-1.7.30.tar.gz.
File metadata
- Download URL: genshin-1.7.30.tar.gz
- Upload date:
- Size: 138.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ad95a60cc6e5e91790dce8de2145ca8cb5234f565792b7bc6c5e6379333e466
|
|
| MD5 |
80203a1a668027f06b0bd4786130261c
|
|
| BLAKE2b-256 |
3f5b3352a1e36422527446c8a25a3339b3c106ca1e50914b897113ed3656b3d6
|
File details
Details for the file genshin-1.7.30-py3-none-any.whl.
File metadata
- Download URL: genshin-1.7.30-py3-none-any.whl
- Upload date:
- Size: 194.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
37218ed46112c0e101fee53deb923c199ee43955f3fa7dd0c620949fb4cfbd63
|
|
| MD5 |
8a0b3780bbba0264ee9bda613e213ebf
|
|
| BLAKE2b-256 |
29ae9c9f7962b1beac1c24f93c63b2b23f99263975dd41da3fc4e6e3cb355e0c
|
