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

Uploaded Source

Built Distribution

genshin-1.5.1-py3-none-any.whl (108.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for genshin-1.5.1.tar.gz
Algorithm Hash digest
SHA256 cc7fa889dba78868357cdb81b78e0418d8805a1b230661a76e897af41fe21dfe
MD5 eac809c1106ff45f097d1d8523a86e99
BLAKE2b-256 95085761b92ed9e3116ecafcad1c64e22829cfd01dff58899de60d3c66567ae6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for genshin-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fc62b3054bdda0a7caf30051018ef5fd139ec165d33275ae76c582b41e3d7487
MD5 d6d35acb0f9434b710317d3e3f3b4f94
BLAKE2b-256 3912bd9d9258c93d910fb61e808b2b4e682a8e70d810f8b762e0d25c624babf7

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