Skip to main content

Async client for Satisfactory dedicated server APIs

Project description

aiosatisfactory

This is an async Python library for Satisfactory dedicated server's APIs.

This work is based off the official documentation that is provided with the game files or is also available on the official wiki

Lightweight API (docs)

This API should be used to poll the server state before making most of the https requests
No errors are raised but you must check if the query was succesful

Usage:

from aiosatisfactory import SatisfactoryServer
import time

client = SatisfactoryServer("server.ip")
query = await client.lightweight.query(time.time_ns()) #We use time to generate a Cookie
    if query is not None:
        print(query.response)

Https API (docs)

This API requires the session parameter to be set in the SatisfactoryServer constructor
It does raise an ErrorResponse exeption if the function you try to execute fails

Usage:

import asyncio
from aiosatisfactory import SatisfactoryServer

async def main():

    with aiohttp.ClientSession() as session:
        client = SatisfactoryServer("server.ip", session=session)
        try:
            response = await client.https.api.health_check()
            print(response.health)
        except ErrorResponse as e:
            print(f"Error: {e.error_code, e.error_message, e.error_details}")

asyncio.run(main())

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

aiosatisfactory-0.1.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiosatisfactory-0.1.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file aiosatisfactory-0.1.1.tar.gz.

File metadata

  • Download URL: aiosatisfactory-0.1.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiosatisfactory-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c015876c9fa7bbb02859ba1a6e3b1aa0224bb00179899f44238b9e80b4c2ddcf
MD5 3f5646cce098dbeeca9b167bfceefd3d
BLAKE2b-256 0f8d2157e2eab433bc2b5659658746a7632dfba7410d78c8bbddd1324b7c62fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiosatisfactory-0.1.1.tar.gz:

Publisher: python-publish.yml on Rikys/aiosatisfactory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiosatisfactory-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aiosatisfactory-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0ca2aa5c08fee32cb1f6120cf3dc5e56d3881fcefc40a53d1e7f83862108e3a7
MD5 57866a58492da8c4622d57123bc4df06
BLAKE2b-256 ab96663b57611cb525ef32612053b04745c8893d87b4e08e2e532d470ebae2c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiosatisfactory-0.1.1-py3-none-any.whl:

Publisher: python-publish.yml on Rikys/aiosatisfactory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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