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

API Reference: https://thesadru.github.io/genshin.py/pdoc/genshin

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

Uploaded Source

Built Distribution

genshin-1.6.1-py3-none-any.whl (118.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.6.1.tar.gz
  • Upload date:
  • Size: 86.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for genshin-1.6.1.tar.gz
Algorithm Hash digest
SHA256 66577ab35c90069bbaf9819f50472e3d503384f0a467ee18cc2f28f21a06a71d
MD5 270a1d01ef61ae70fc3ff6405c6c8089
BLAKE2b-256 1f8a9a1f7d7d990e9a9ae507f853fd6aec1ce48fc4903266948099b4147319a7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 118.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for genshin-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 39404af42147c1aa257a3f37bcfcf8e7d43aa6b1e2c3de7fcf1a44814b064c52
MD5 321f6f809633ac369a2fd9593581e395
BLAKE2b-256 01446d8381a3a13a583e98bf505bc3ec6fc432ab00536740e46ee9ea3c97f2f5

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