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

Uploaded Source

Built Distribution

genshin-1.6.0-py3-none-any.whl (117.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: genshin-1.6.0.tar.gz
  • Upload date:
  • Size: 85.8 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.0.tar.gz
Algorithm Hash digest
SHA256 3468fb3f3f9e222ec69a85b77518c25cc5b3ee90414b7572206890c9fab92462
MD5 7ba3b3cf716f7db7c03e7decc246b786
BLAKE2b-256 e4f96301260bbf9a3caa8e1a1a7dda307e5460b9df65a219c6296cc847254aaf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: genshin-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 117.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3cbff89afaab5cff56c9e559eb8bac41293e2a2136d5299d5ba16aa79acf848
MD5 fb4187258c34286d283e1457bd50c595
BLAKE2b-256 a6fbf33bc3847946a410ce077b6078d54fb328dcfa49e354160d0ca837b44fe7

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