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.2.tar.gz (2.7 kB view hashes)

Uploaded Source

Built Distribution

palworld_api-1.0.2-py3-none-any.whl (3.2 kB view hashes)

Uploaded Python 3

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