Skip to main content

A library for interaction with the Hytale API.

Project description

hytale-api

Unofficial Python library for interacting with the Hytale API.

⚠️ This library is unofficial and based on publicly discovered endpoints.

Hytale is set to release on the 13th of January and I hope more documented and more useful endpoints can be added.

Get Started

Installation

pip install hytale-api

OR

pip install git+https://github.com/DRagssss/hytale-api.git

Example Use

This package consists of some endpoints that do not need any authorization (since they are basic information which are accessible on the Hytale website) so it's extremely easy to use.

Get excerpts of the latest 3 blogs.

from hytale import get_blogs

blogs = get_blogs()  # limit defaults to 3

for blog in blogs:
    print(blog.bodyExcerpt)  # first couple sentences of body

You can also get the entire HTML body of a singular blog.

from hytale import get_blog

slug = "hytale-s-1st-faq"  # this will get the blog from https://hytale.com/news/2025/12/hytale-s-1st-faq
blog = get_blog(slug)

print(blog.body)  # very long HTML content

All endpoints to do with accounts such as username reservations and game profiles require a logged-in user to access them. This is checked by the accounts API using the "ory_kratos_session" cookie value. To get this follow the steps below.

  1. Login at https://hytale.com and then open dev tools in your browser (shortcut Ctrl-Shift-C.)
  2. Navigate to the Application or Storage and then go to Cookies.
  3. Go to cookies under the URL https://accounts.hytale.com.
  4. Copy the value of the ory_kratos_session cookie.

This is how the AccountClient object is used.

from hytale import AccountClient

client = AccountClient("YOUR_SESSION_COOKIE_VALUE")

available = client.get_available("MrBeast")  # check if the MrBeast username is available (example)

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

hytale_api-2.0.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hytale_api-2.0.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file hytale_api-2.0.0.tar.gz.

File metadata

  • Download URL: hytale_api-2.0.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for hytale_api-2.0.0.tar.gz
Algorithm Hash digest
SHA256 f671d62ea532f897023fcb5cb975e6e9324b5b15c37a19ed70df34bfd0da4b2b
MD5 94e271c2c4678dcb10008bf71558f234
BLAKE2b-256 abb4da074cf09e610f98b4c57f6c0856a9f31e7a8da10f7474bbc6e89cc94b11

See more details on using hashes here.

File details

Details for the file hytale_api-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: hytale_api-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for hytale_api-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32d5633b6786fc38d7ac44d997718538547d647cb2d3c3840f2d7823be0b2fea
MD5 750792589345b22c4cded14581449bdf
BLAKE2b-256 9902907c8a4224c95a131846a091736b800e3356ff8d3e372dfa0677e5975b33

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page