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-1.0.5.tar.gz (2.6 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-1.0.5-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for palworld-api-1.0.5.tar.gz
Algorithm Hash digest
SHA256 c7b441450cdcf115998b75ed050700a9228c571559a58fb1d96756eaa8a02c35
MD5 c39093255aec23574ae0cbfaef5a1e9a
BLAKE2b-256 c8f72bc0dd73be63cc5a4807663edc1c55acbd24f13930ae477dc753f820ebc0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: palworld_api-1.0.5-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-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4d9fde1543c9f19e79b692404a33e2c100ee3f0acc0a51e2e26ffc3e4519671c
MD5 e982e8e478e4d0a3458473fa2e122198
BLAKE2b-256 2e307e73f55b6ce1383c00a5d6c3915c8ddd04ae7acc360e5c532bfd8dfa94f7

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