pssapi

pssapi.py

An async client library to access the Pixel Starships API.

✨ Features

• Fully typehinted so your favorite IDE can assist you with code completion.
• Easy access to any instance of a Pixel Starships API server.
• Fast setup to get you started quickly.
• Caching versioned endpoints to cut down traffic between your app and the servers.

🔍 Future plans

• Use and support pydantic models
• Implement aliases and properties to map values displayed in-game to the raw values returned by the API

🚀 Demo

To retrieve a list of all item designs:

import asyncio
from pssapi import PssApiClient

async def main():
    client = PssApiClient()

    item_designs = await client.item_service.list_item_designs()
    print(f"Found {len(item_designs)} item designs.")
    print(f"First item: {item_designs[0].item_design_name}")

if __name__ == "__main__":
    asyncio.run(main())

⚙️ Installation

Python 3.11 or higher is required

To install the latest version of this library, run the following command:

pip install -U pssapi

🖊️ Contribute

If you ran across a bug or have a feature request, please check if there's already an issue for that and if not, open a new one.

If you want to fix a bug or add a feature, please check out the Contribution Guide.

🆘 Support

If you need help using the library or want to contribute, you can join the support Discord at: discord.gg/kKguSec

👥 Contributors

• The worst.
• Solevis
• architelos

🔗 Links

• Documentation (tbd)
• Official Support Discord server
• Pixel Starships homepage
• Official Pixel Starships Discord (not affiliated to this library)