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.0.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.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiosatisfactory-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 e44978aa039456beb38720dcff8349ac3530d024e786cc23fb12a2a80e2315df
MD5 662e123200885c53eea426fc281b74c1
BLAKE2b-256 c74788d1323f6f33490de39730a7fd64a30bee8ed926b87057a524245028ae00

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiosatisfactory-0.1.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aiosatisfactory-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec588d8b8d8d3fd3836d4a5c715a8e102014dee4741ae228e56eeaeef2874bb1
MD5 20e1a377110140245583054d211ab017
BLAKE2b-256 a2f575077da6bc7d13f0bab3d3db879be9cb9c8f879bb62ad280236b97e27bfc

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiosatisfactory-0.1.0-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