Skip to content

A simple Python 3.6+ wrapper of ArchiSteamFarm IPC API

License

Notifications You must be signed in to change notification settings

deluxghost/ASF_IPC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ASF_IPC

license PyPI PyPI

A simple Python 3.6+ library of ArchiSteamFarm IPC API

Examples

Installation

pip install ASF_IPC

Usage

Initialization

import ASF_IPC as asf

api = asf.IPC(host='127.0.0.1', port=1242, password='blablabla')

Fetch general data about ASF

data = api.get_asf()

Fetch status of bots

data = api.get_bot('name of bot') # One bot
data = api.get_bot(['name', 'of', 'bots']) # Multiple bots

Note: method get_bot() returns dict.

Erase bots

api.delete_bot('name of bot') # One bot
api.delete_bot(['name', 'of', 'bots']) # Multiple bots

Create/update config of a bot

api.post_bot('name of bot', config={'BotName': 'foobar'}, keep_sensitive=True)

Execute command

message = api.command('version')

Note: method command() returns str.

Get structure and type

data = api.get_structure('ArchiSteamFarm.BotConfig')
data = api.get_type('ArchiSteamFarm.BotConfig')

Note: these methods return dict, check ASF Wiki for details.

Don't forget to catch errors

ASF_IPC will raise every single error as an exception.

About

A simple Python 3.6+ wrapper of ArchiSteamFarm IPC API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages