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.2.4.tar.gz (67.7 kB view details)

Uploaded Source

Built Distribution

genshin-1.2.4-py3-none-any.whl (91.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for genshin-1.2.4.tar.gz
Algorithm Hash digest
SHA256 b64010f16a7b911a53a3ba8834dc2cd08149c052705438e7b07c7bb8fa12e7de
MD5 36831bf100a88c2642855fa5d3591e92
BLAKE2b-256 a206e42875d2961d018549dfda95a1ab92fd42552bdcb0f2e4b46620dbe8b5b0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for genshin-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 acaf1380e8cdb7032b0fc6d26f4c74de6dc72c55d662b7d0fcd14dfc4d014dff
MD5 6b41cec9510e31cbdcd03287a3ff7b98
BLAKE2b-256 c7189c57a7c381d34523c82c8da68723f6c9eb0c00d0df40ab1ed66e79828442

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