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.1

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.8+
  • 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-1.0.1.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

palworld_api-1.0.1-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for palworld-api-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2db6ff75bb783c5ef622bf58c1fe9e2a581b3f5b75330e87c61d155601d98624
MD5 b1f81169688a9b4982e328b88eb92982
BLAKE2b-256 4ab59042e7c7e0864386a17760e539aab3349f74e9c5ec1694c5f80b725fec47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for palworld_api-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f69c6f23d3a5b7014f9072bbb1ef1a8ec5eb7defa4b5ad56cd8e46df8d5a22d8
MD5 bb3dce99607be7fb428afeac2580b4eb
BLAKE2b-256 cf2f780de91d9f60519f6ae166f23722e993d46d2484d84adba4ccf8efee9c8c

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