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

Uploaded Source

Built Distribution

genshin-1.2.3-py3-none-any.whl (91.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for genshin-1.2.3.tar.gz
Algorithm Hash digest
SHA256 41965f52a7820678fe64eec1c406a9ea0e27862ff74ce421946e7c0542e18c65
MD5 7a0b74d922420e69bbc211ce085c5cec
BLAKE2b-256 8796da1cefb379c38584abccaa8e18e6a68b95e6800da41c694379e1b8d725f0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for genshin-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 636068068e9934038aec87229a45c82c45e9f879ab931cdcfc30b79a4d829f8f
MD5 8dd37d04e15b3edc1786310f3d8a3cf6
BLAKE2b-256 330354dc017f0fbbe078412d1a489243872db02cf74ac4c5270e43d46e923da4

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