Skip to main content

A Python API wrapper for the Palworld Rest API.

Project description

Palworld REST API Wrapper

This is a simple Palworld REST API Wrapper for Python project. This supports all API endpoints for Palworld.

Version

v1.0.5

Installation

  1. Install palworld-api using pip:
    pip install palworld-api
    
  2. Import into your project.
    import asyncio
    from palworld_api import PalworldAPI
    

Requirements

  • Python 3.11+
  • RestAPI Enabled

Usage

Refer to example files to get an idea of how this works. Here is a basic usage:

import asyncio
from palworld_api import PalworldAPI

async def main():
   server_url = "http://localhost:8212"
   username = "admin"
   password = "admin password"
   api = PalworldAPI(server_url, username, password)

   server_info = await api.get_server_info()
   print("Server Info:", server_info)

if __name__ == "__main__":
   asyncio.run(main())

Resources

For detailed documentation on the Palworld REST API, check out the official REST API Documentation.

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

palworld-api-2.0.0.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

palworld_api-2.0.0-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file palworld-api-2.0.0.tar.gz.

File metadata

  • Download URL: palworld-api-2.0.0.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for palworld-api-2.0.0.tar.gz
Algorithm Hash digest
SHA256 725d0aa1a9fb99a77754c4f638046b4509c29468dec53613bc1ad1817dea73d9
MD5 2014c2480343edd3c62ea4fcaeb5267e
BLAKE2b-256 10cc07f2c25b4152f1d06fbcee3c2fb219f628b8dfd3b0739af01c56c94fed3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: palworld_api-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for palworld_api-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0e807f5955e9dbdeea9b7791da8f4bbd852f59b15f86d80659213ed454cb39a
MD5 896e8e5a690bf90e34f47a6f7a38e178
BLAKE2b-256 3b2de08e6fd159e94bdd327d1e5fa651f2f910ed49632f9b12dfd390bc4aa1aa

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