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

Uploaded Source

Built Distribution

genshin-1.2.2-py3-none-any.whl (91.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.2.2.tar.gz
  • Upload date:
  • Size: 67.0 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.2.tar.gz
Algorithm Hash digest
SHA256 3ee809d58f3be7bb3bcd17535b2d4f26a217f78cb899e2aaa3379fa558fe458d
MD5 22d13d4b504db884da08c1812492df5b
BLAKE2b-256 d371fcf2dcafd914f1bc2c835e789b5f1182d4d52e99ded1f6e8a60ec030d821

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 91.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dfdcb76d845a587681eb14c59b222ba310897c662d5d0c02bf8079000bf6ca55
MD5 040386426a42174a255540cbb695af11
BLAKE2b-256 367c465e3afaca3328129341242c879226a567582e50f96a530397f16b8fa26c

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