Satisfactory Dedicated Server SDK

A TypeScript / JavaScript SDK for interacting with the Satisfactory dedicated server API.

Features

• Easy-to-use interface for managing and querying your Satisfactory dedicated server
• Written in TypeScript with type definitions included
• Supports common server API endpoints for authentication, player management, server status, and more
• Lightweight with minimal dependencies
• Works in Node.js and modern JS environments

Installation

npm install satisfactory-dedicated-server-api
# or
yarn add satisfactory-dedicated-server-api

Documentation

Full documentation is available on the GitHub Pages site:

• Getting Started Guide: Docs / Guides / Getting Started
• Error Handling Guide: Docs / Guides / Error Handling
• API Reference: Docs / API
• Examples: Docs / Examples

💡 Tip: Check the guides for setup, authentication, and example usage before diving into the API reference.

Basic Usage

import { SatisfactoryApi, MinimumPrivilegeLevel } from 'satisfactory-dedicated-server-api';

const api = new SatisfactoryApi('127.0.0.1', 7777);

// Fetch and trust the server certificate before making requests
await api.initCertificate();

// Check if server is online
const health = await api.healthCheck();
if (health.success) console.log('Server is online');

// Authenticate
await api.passwordlessLogin(MinimumPrivilegeLevel.ADMINISTRATOR);

// Query server state
const state = await api.queryServerState();
console.log(state.data);

For more examples and advanced features, see the Guids section on the docs site.

Contributing

Contributions, issues, and feature requests are welcome!

• Check issues for known bugs and feature requests.
• Pull requests are encouraged — follow the coding style in the SDK.

License

This project is licensed under the MIT License — see the LICENSE file for details.

Disclaimer: This software has no affiliation with Satisfactory or Coffee Stain Studios. It is a community project to interact with the Satisfactory dedicated server API.