Palworld.RestClient 1.0.0

.NET Standard 2.0

dotnet add package Palworld.RestClient --version 1.0.0

NuGet\Install-Package Palworld.RestClient -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Palworld.RestClient" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Palworld.RestClient" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Palworld.RestClient" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Palworld.RestClient --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Palworld.RestClient, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Palworld.RestClient@1.0.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Palworld.RestClient&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Palworld.RestClient&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Palworld.RestClient

A .NET REST API client for the Palworld dedicated server REST API.

Installation

dotnet add package Palworld.RestClient

Usage

Without dependency injection

using Palworld.RestClient;

using var client = PalworldClient.Create("http://localhost:8212", "your-password");

var info = await client.GetServerInfoAsync();
Console.WriteLine($"{info?.ServerName} ({info?.Version})");

var players = await client.GetPlayersAsync();
foreach (var player in players ?? [])
    Console.WriteLine($"{player.Name} — Level {player.Level} — {player.Ping}ms");

With dependency injection

Install the companion package:

dotnet add package Palworld.RestClient.Extensions.DependencyInjection

builder.Services.AddPalworldClient(
    baseAddress: "http://localhost:8212",
    password: "your-password");

Inject and use:

public class MyService(PalworldClient palworld)
{
    public async Task KickCheaterAsync(string userId)
        => await palworld.KickPlayerAsync(userId, "Cheating is not allowed.");
}

Available Methods

Method	Description
`GetServerInfoAsync()`	Server version, name, and description
`GetMetricsAsync()`	FPS, player count, uptime, and more
`GetSettingsAsync()`	Raw server configuration settings
`GetPlayersAsync()`	List of currently connected players
`KickPlayerAsync(userId, reason)`	Kick a player from the server
`BanPlayerAsync(userId, reason)`	Ban a player from the server
`UnbanPlayerAsync(userId)`	Remove a player's ban
`AnnounceAsync(message)`	Broadcast a message to all players
`ShutdownAsync(waitSeconds, message)`	Gracefully shut down the server after a delay
`SaveAsync()`	Save the current game state
`ForceStopAsync()`	Immediately stop the server process

Requirements

.NET Standard 2.0 or later
A Palworld dedicated server with the REST API enabled

Server configuration

To enable the REST API, set the following in your server's PalWorldSettings.ini:

RESTAPIEnabled=True
AdminPassword="your-password"

The AdminPassword value is what you pass as the password parameter to this client.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- System.Text.Json (>= 10.0.10)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Palworld.RestClient:

Package	Downloads
Palworld.RestClient.Extensions.DependencyInjection Microsoft.Extensions.DependencyInjection integration for Palworld.RestClient.	194

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.0	169	7/17/2026
1.0.0-preview.1	71	7/16/2026