Skip to main content

Python wrapper for PluralKit's API.

Project description

PyPi Version Documentation Status Discord server invite

Python wrapper for PluralKit's API.


Python 3.6 or higher is required.

# linux/macOS
python3 -m pip install -U pluralkit

# windows
py -3 -m pip install -U pluralkit

Quick examples

Provided a system's authorization token, the examples below print the system description and list the system's members.

Async usage was created with in mind, and so the default implementation is asynchronous.

from pluralkit import Client
import asyncio

pk = Client("token") # your token here

async def main():
   system = await pk.get_system()

   members = pk.get_members()
   async for member in members:
      print(f"{} (`{}`)")

loop = asyncio.get_event_loop()

Synchronous usage

Blocking execution may be specified with the client argument async_mode=False.

from pluralkit import Client

pk = Client("token", async_mode=False)

system = pk.get_system()

members = pk.get_members()
for member in members:
   print(f"{} (`{}`)")


The client can be used without one's PluralKit authorization token, but it's required for editing one's system or members or for accessing one's private system or member info.

Contributors ✨

Thanks to these wonderful people (emoji key) and users in the Discord who actively supported development:





Ashton Power


System in a Box





Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pluralkit-1.1.5.tar.gz (56.8 kB view hashes)

Uploaded source

Built Distribution

pluralkit-1.1.5-py3-none-any.whl (38.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page