AIOSTEAMPY

Manage Steam sessions, Guard, Market, trade offers and more.

[!WARNING] The project is heading toward 1.0.0 and there can be some changes until stable release but library design as a whole with most API will stay.

[!IMPORTANT] Beta Steam Market methods, models, and related functionality will replace old when Steam migrate their website keeping old names whenever possible. No longer functional methods will be removed conveniently.

Documentation

• 📖 Project documentation is available at aiosteampy.somespecial.one.
• 🧠 Generated DeepWiki.

Installation

Project published on PyPI under aiosteampy name so can be installed with:

pip install aiosteampy
poetry add aiosteampy
uv add aiosteampy

Prereleases

To install prerelease versions (alpha, beta, release candidates), consider allowing the package manager to do it:

pip install --pre aiosteampy
poetry add --allow-prereleases aiosteampy
uv add --prerelease aiosteampy

Extras

Extras can be installed with aiosteampy[<extra>] install target.

Project uses aiohttp as default HTTP transport with all its capabilities and limitations.

• socks - enable socks type web proxy support for default HTTP transport.
• wreq - wreq-python HTTP transport implementation. Supports proxies, HTTP/2, and browser impersonification. Will be used automatically once installed.

Quick start

Package separated into main modules which can be imported from aiosteampy namespace:

• session - Steam Session management and auth tokens negotiation.
• guard - Steam Guard/Mobile Authenticator (2FA) functionality.
• client - abstract container for Steam domains implementations (Market, Trade Offers, etc.).

Session

SteamSession provides functionality to log into user account using either credentials or QR. When the login process has been finalized web auth cookies can be obtained to enable interaction with SteamCommunity domains like Confirmations (see guard), Market, TradeOffers, Profile and Inventory (see client). Methods serialize and deserialize allows to dump/load SteamSession into/from JSON-safe dict.

Demonstrative example of using SteamSession to log into account with credentials, obtaining web cookies and finally dump session into file:

import asyncio
import json

from aiosteampy.session import SteamSession, GuardConfirmationRequired


async def login_with_credentials():
    session = SteamSession()

    account_name = input("Input login: ")
    password = input("Input password: ")

    try:
        await session.with_credentials(account_name, password)
    except GuardConfirmationRequired as e:
        if e.email_code:
            code = input("Code from Steam has been sent to your email. Paste it here: ")
            await session.submit_auth_code(code, "email")
        elif e.device_code:
            code = input("Input code from Mobile Device Authenticator: ")
            await session.submit_auth_code(code, "device")
        else:
            input(
                ("Steam requests device or email confirmation. "
                 "Click on the link from email or mobile application and press enter.")
            )

    await session.finalize()

    print("Access token: ", session.access_token)
    print("Refresh token: ", session.refresh_token)

    await session.obtain_cookies()

    print("Web cookies obtained!")

    await session.transport.close()

    session_dump = session.serialize()

    with open(f"./{account_name}.session.json", "w") as f:
        json.dump(session_dump, f, indent=2)


asyncio.run(login_with_credentials())

Session can then be loaded from a dump. Although not verified for expiration, tokens and cookies will be restored:

with open(f"./{account_name}.session.json", "r") as f:
    session = SteamSession.deserialize(json.load(f))

Guard

SteamGuard embodies Steam Mobile Authenticator functionality from mobile app. Can activate account 2FA (similar to using SDA), generate auth codes, sign auth requests made with other SteamSession by QR, handle Steam Confirmations. Eventually, guard requires session with mobile app platform.

Here we're using SteamGuard to activate Authenticator and dump SteamGuardAccount data into a file then:

import json
import asyncio

from aiosteampy.session import SteamSession, Platform
from aiosteampy.guard import SteamGuard, SmsConfirmationRequired, EmailConfirmationRequired


async def enable_two_fa():
    session = SteamSession(..., platform=Platform.MOBILE)

    guard = SteamGuard(session)

    try:
        guard.enable()
    except SmsConfirmationRequired as e:
        code = input(f"Guard activation code has been sent to your phone ({e.phone_hint}). Paste it here: ")
    except EmailConfirmationRequired:
        code = input("Guard activation code has been sent to your email. Paste it here: ")

    await guard.finalize(code)

    # Exported guard account contains secrets that cannot be retrieved once more
    # therefore, data must be saved ASAP to prevent loss of access to a user's Steam account
    guard_account = guard.export_account()
    with open(f"./{session.account_name or session.steam_id}.guard.json", "w") as f:
        json.dump(guard_account.serialize(), f)

    await guard.transport.close()


asyncio.run(enable_two_fa())

Client

SteamClient composes all Steam domains implementations: Market, Trade Offers, Inventory, Profile, Wallet and more. Each domain is responsible for related functionality. For example, Market domain contain methods allow to retrieve and buy listings from Steam Market, place buy and sell orders. Trade Offers provides methods to send, accept or deny offers and so on.

There is also a SteamPublicClient entity in aiosteampy.client namespace that allows interaction with Steam from unauthenticated (anonymous) user perspective.

Using SteamClient with authenticated SteamSession to get current user inventory items:

import asyncio

from aiosteampy.session import SteamSession
from aiosteampy.client import SteamClient, AppContext, App


async def get_inventory():
    session = SteamSession(...)

    client = SteamClient(session)

    # use predefined apps and their contexts
    cs2_default_inv = await client.inventory.get(AppContext.CS2)
    print("CS2 items: ", cs2_default_inv.items)

    cs2_trade_protected_inv = await client.inventory.get(AppContext.CS2_PROTECTED)
    print("CS2 trade protected items: ", cs2_trade_protected_inv.items)

    # create new App and AppContext
    BongoCatApp = App(3419430, "Bongo Cat")
    BongoCatDefault = BongoCatApp.with_context(2)

    bongo_cat_inv = await client.inventory.get(BongoCatDefault)
    print("Bongo Cat items: ", bongo_cat_inv.items)

    await client.transport.close()


asyncio.run(get_inventory())

Retrieving item orders histogram from SteamMarket with an unauthenticated client:

import asyncio

from aiosteampy.client import SteamPublicClient, App


async def get_histogram():
    client = SteamPublicClient()

    # Glock-18 | Fully Tuned (Field-Tested)
    histogram = await client.market.get_orders_histogram(176611887)

    print("Get histogram: ", histogram)

    await client.transport.close()


asyncio.run(get_histogram())

Key features ✨

• Stateful: Manages user sessions state throughout the lifecycle.
• Declarative: There are models for almost every data.
• Typed: High-end support with extensive typing.
• Friendly: Intuitive and straightforward API.
• Flexible: Custom HTTP transport layer can be implemented to fit user needs.
• Asynchronous: Fully async implementation using asyncio.

What I can do with this

• Login using credentials and QR, obtain auth web cookies.
• Operate Trade Offers: send, accept, decline, and counter.
• Place and cancel buy/sell orders, purchase listings directly on Steam Market.
• Dump & Load tokens and cookies to enable Session persistence.
• De/serialize Client state reducing boilerplate.
• Retrieve, accept, and deny Steam Mobile Device confirmations.
• Enable Steam Mobile Authenticator for user account and save secrets.
• Import secrets from famous SDA format (maFile).
• Setup, edit information of user Steam profile.
• Get user account wallet balance, redeem Wallet or Gift codes.
• Inspect CS2 items.
• Lost access to a user account by denying guidelines and warnings while being unvigilant.
• And more!

What I can't do

• Buy app and their package on Steam Store.
• WebSocket connection to Steam servers.
• Interact with game servers (like find game match).
• Social interaction like groups, clans, and chat.
• Get confused with the complexity of usage.

Contribution 💛

Feedback, suggestions, and bug reports are welcome!

If you have any question regarding a project, don't hesitate to ask one in Q&A.

Before creating a pull request, please try to keep project style and code quality while contributing. Use formatter (currently Ruff) whenever possible respecting configuration in pyproject.toml. Remove unrelated code changes from PR and generally be concise, thanks!.

Credits

Sources of inspiration and ideas, concepts, and general knowledge:

• DoctorMcKay/node-steam-session
• DoctorMcKay/node-steamcommunity
• dyc3/steamguard-cli
• SteamRE/SteamKit
• DoctorMcKay/node-steamstore
• DoctorMcKay/node-steam-totp
• SteamTracking/Protobufs
• Gobot1234/steam.py
• steamapi.xpaw.me
• bukson/steampy

Helpful links

• Steam Market id's storage repo
• Jessecar96/SteamDesktopAuthenticator
• achiez/NebulaAuth-Steam-Desktop-Authenticator
• Identifying Steam items
• CS2 Items Schema