steampy.client.SteamClient

class documentation

class SteamClient: (source)

Constructor: SteamClient(api_key, username, password, steam_guard, ...)

View In Hierarchy

Undocumented

Static Method is_invalid_api_key Undocumented
Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Undocumented
Method accept_trade_offer Undocumented
Method api_call Undocumented
Method cancel_trade_offer Undocumented
Method decline_trade_offer Undocumented
Method get_escrow_duration Undocumented
Method get_friend_list Undocumented
Method get_my_inventory Undocumented
Method get_partner_inventory Undocumented
Method get_profile Undocumented
Method get_steam_id Undocumented
Method get_trade_history Undocumented
Method get_trade_offer Undocumented
Method get_trade_offers Undocumented
Method get_trade_offers_summary Undocumented
Method get_trade_receipt Undocumented
Method get_wallet_balance Undocumented
Method is_session_alive Undocumented
Method login Undocumented
Method logout Undocumented
Method make_offer Undocumented
Method make_offer_with_url Undocumented
Method set_login_cookies Undocumented
Method set_proxies Undocumented
Instance Variable market Undocumented
Instance Variable steam_guard Undocumented
Instance Variable steam_guard_string Undocumented
Instance Variable username Undocumented
Instance Variable was_login_executed Undocumented
Static Method _create_offer_dict Undocumented
Static Method _filter_non_active_offers Undocumented
Static Method _get_trade_offer_url Undocumented
Method _confirm_transaction Undocumented
Method _fetch_trade_partner_id Undocumented
Method _get_session_id Undocumented
Instance Variable _api_key Undocumented
Instance Variable _password Undocumented
Instance Variable _session Undocumented
@staticmethod
def is_invalid_api_key(response: requests.Response) -> bool: (source)

Undocumented

def __enter__(self): (source)

Undocumented

def __exit__(self, exc_type, exc_val, exc_tb): (source)

Undocumented

def __init__(self, api_key: str, username: str = None, password: str = None, steam_guard: str = None, login_cookies: dict = None, proxies: dict = None): (source)

Undocumented

@login_required
def accept_trade_offer(self, trade_offer_id: str) -> dict: (source)

Undocumented

def api_call(self, method: str, interface: str, api_method: str, version: str, params: dict = None) -> requests.Response: (source)

Undocumented

def cancel_trade_offer(self, trade_offer_id: str) -> dict: (source)

Undocumented

def decline_trade_offer(self, trade_offer_id: str) -> dict: (source)

Undocumented

@login_required
def get_escrow_duration(self, trade_offer_url: str) -> int: (source)

Undocumented

def get_friend_list(self, steam_id: str, relationship_filter: str = 'all') -> dict: (source)

Undocumented

@login_required
def get_my_inventory(self, game: GameOptions, merge: bool = True, count: int = 5000) -> dict: (source)

Undocumented

@login_required
def get_partner_inventory(self, partner_steam_id: str, game: GameOptions, merge: bool = True, count: int = 5000) -> dict: (source)

Undocumented

def get_profile(self, steam_id: str) -> dict: (source)

Undocumented

@login_required
def get_steam_id(self) -> int: (source)

Undocumented

def get_trade_history(self, max_trades: int = 100, start_after_time=None, start_after_tradeid=None, get_descriptions: bool = True, navigating_back: bool = True, include_failed: bool = True, include_total: bool = True) -> dict: (source)

Undocumented

def get_trade_offer(self, trade_offer_id: str, merge: bool = True) -> dict: (source)

Undocumented

def get_trade_offers(self, merge: bool = True) -> dict: (source)

Undocumented

def get_trade_offers_summary(self) -> dict: (source)

Undocumented

@login_required
def get_trade_receipt(self, trade_id: str): (source)

Undocumented

@login_required
def get_wallet_balance(self, convert_to_decimal: bool = True, on_hold: bool = False) -> Union[str, Decimal]: (source)

Undocumented

@login_required
def is_session_alive(self) -> bool: (source)

Undocumented

def login(self, username: str = None, password: str = None, steam_guard: str = None): (source)

Undocumented

@login_required
def logout(self): (source)

Undocumented

@login_required
def make_offer(self, items_from_me: List[Asset], items_from_them: List[Asset], partner_steam_id: str, message: str = '') -> dict: (source)

Undocumented

@login_required
def make_offer_with_url(self, items_from_me: List[Asset], items_from_them: List[Asset], trade_offer_url: str, message: str = '', case_sensitive: bool = True) -> dict: (source)

Undocumented

def set_login_cookies(self, cookies: dict): (source)

Undocumented

def set_proxies(self, proxies: dict) -> dict: (source)

Undocumented

market = (source)

Undocumented

steam_guard = (source)

Undocumented

steam_guard_string = (source)

Undocumented

username = (source)

Undocumented

was_login_executed: bool = (source)

Undocumented

@staticmethod
def _create_offer_dict(items_from_me: List[Asset], items_from_them: List[Asset]) -> dict: (source)

Undocumented

@staticmethod
def _filter_non_active_offers(offers_response): (source)

Undocumented

@staticmethod
def _get_trade_offer_url(trade_offer_id: str) -> str: (source)

Undocumented

def _confirm_transaction(self, trade_offer_id: str) -> dict: (source)

Undocumented

def _fetch_trade_partner_id(self, trade_offer_id: str) -> str: (source)

Undocumented

def _get_session_id(self) -> str: (source)

Undocumented

_api_key = (source)

Undocumented

_password = (source)

Undocumented

_session = (source)

Undocumented