Skip to main content

An API wrapper for Genshin Impact.

Project description

genshin.py

Downloads PyPI package Last Commit Coverage Discord

Modern API wrapper for Genshin Impact & Honkai Impact 3rd 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.Client(cookies)

    data = await client.get_genshin_user(710785423)
    print(f"User has a total of {data.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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

genshin-1.3.0.tar.gz (71.0 kB view details)

Uploaded Source

Built Distribution

genshin-1.3.0-py3-none-any.whl (95.6 kB view details)

Uploaded Python 3

File details

Details for the file genshin-1.3.0.tar.gz.

File metadata

  • Download URL: genshin-1.3.0.tar.gz
  • Upload date:
  • Size: 71.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for genshin-1.3.0.tar.gz
Algorithm Hash digest
SHA256 7c133f6152a5725b049cb098ce8eedb5972f143d254a8bc214b8604abedec920
MD5 ec1a5acec64ca73f7cffa9fbef710ae8
BLAKE2b-256 5c8806501388f4e3b9811d3a7c629f8706cd1efaf109198353e4f1e6698f1c88

See more details on using hashes here.

File details

Details for the file genshin-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: genshin-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 95.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for genshin-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67a90bee9543106534e6180813c48b74007a513a5fdb6f69c299efaa73c909c6
MD5 2c6bf6ad83f6294900e09a5a67a0af25
BLAKE2b-256 e36923474ff02505d40ec6da3a5e9dbb6564c0d2fd0a2606d6ca877a816bb194

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page