genshin.py
Modern API wrapper for Genshin Impact built on asyncio and pydantic.
Documentation: https://thesadru.github.io/genshin.py
Source Code: https://github.com/thesadru/genshin.py
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.
Note: This library is a successor to genshinstats - an unofficial wrapper for the Genshin Impact api.
Requirements
- Python 3.8+
- aiohttp
- Pydantic
pip install genshin
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.GenshinClient(cookies)
data = await client.get_user(710785423)
print(f"User has a total of {len(data.characters)} characters")
await client.close()
asyncio.run(main())
Contributing
Any kind of contribution is welcome.
Before making a pull request remember to test your changes using pytest. Remember to set your LTUID
and LTOKEN
environment variables.
pip install genshin[test]
python -m pytest
Please also edit the documentation accordingly. You may see how the final documentation would look like by starting an mkdocs
server.
pip install genshin[doc]
mkdocs serve
I am currently looking for any chinese mainland players who could share their account_id
and cookie_token
cookies to allow for testing of chinese endpoints.