steampy Documentation

Steampy supports two ways to handle SteamGuard:

1. SteamGuard File: Provide a path to a file containing your credentials. The file should be a JSON object with the following keys:
   • steamid: Your SteamID64
   • shared_secret: Your shared secret
   • identity_secret: Your identity secret
2. Manual Secrets: Use the guard module functions to generate one-time codes or confirmation keys using the shared_secret and identity_secret directly.

{
    "steamid": "YOUR_STEAM_ID_64",
    "shared_secret": "YOUR_SHARED_SECRET",
    "identity_secret": "YOUR_IDENTITY_SECRET"
}

Install the steampy library using pip. Requires Python 3.12 or higher.

pip install steampy

You can provide a proxies dictionary during initialization or use set_proxies to configure the session for internal SteamClient requests.

from steampy.client import SteamClient

# Via constructor
proxies = {
    "http": "http://login:password@host:port", 
    "https": "http://login:password@host:port"
}
steam_client = SteamClient('MY_API_KEY', proxies=proxies)

# Via method
steam_client.set_proxies(proxies)

To use most features, you must initialize SteamClient with an api_key. You can then log in using a username, password, and a path to a SteamGuard file. Alternatively, you can log in using browser cookies or a with statement for automatic login/logout management.

from steampy.client import SteamClient

# Standard login
steam_client = SteamClient('MY_API_KEY')
steam_client.login('MY_USERNAME', 'MY_PASSWORD', 'PATH_TO_STEAMGUARD_FILE')

# Login using cookies
login_cookies = {} # provide dict with cookies
steam_client = SteamClient('MY_API_KEY', username='MY_USERNAME', login_cookies=login_cookies)

# Automatic login/logout using context manager
with SteamClient('MY_API_KEY', 'MY_USERNAME', 'MY_PASSWORD', 'PATH_TO_STEAMGUARD_FILE') as client:
    client.some_method1(...)

Retrieve inventory items for a specific game using GameOptions. If merge=True, item descriptions are merged into the item dictionary keyed by item id.

• get_my_inventory(game, merge=True, count=5000)
• get_partner_inventory(partner_steam_id, game, merge=True, count=5000)

from steampy.client import SteamClient, Asset
from steampy.models import GameOptions

steam_client = SteamClient('MY_API_KEY')
steam_client.login('MY_USERNAME', 'MY_PASSWORD', 'PATH_TO_STEAMGUARD_FILE')

game = GameOptions.CS
my_items = steam_client.get_my_inventory(game)

# To create an Asset object for a trade:
item_id = '7146788981'
my_asset = Asset(item_id, game)

The market attribute of SteamClient provides tools for market interaction. Most methods require login().

• fetch_price(item_hash_name, game, currency=Currency.USD): Fetches current market price. Warning: May raise TooManyRequests if called more than 20 times in 60 seconds.
• fetch_price_history(item_hash_name, game): Returns a list of price history entries. Each entry is [date, price, volume].
• get_my_market_listings(): Returns your active market listings.
• create_sell_order(assetid, game, money_to_receive): Creates a sell order. Note: money_to_receive must be in cents (e.g., `

The Currency class provides constants for various Steam currencies. Default is Currency.USD.

# Examples of available currencies
Currency.USD
Currency.GBP
Currency.EURO
Currency.RUB
Currency.CNY
# ... and many others (e.g., JPY, CAD, AUD, etc.)

Functions for handling SteamGuard and authentication codes.

# load_steam_guard(steam_guard: str) -> dict
# If steam_guard is a filename, it loads/parses it. Otherwise, parses as JSON string.

# generate_one_time_code(shared_secret: str, timestamp: int = None) -> str
# Generates a 2FA code for login.

# generate_confirmation_key(identity_secret: str, tag: str, timestamp: int = int(time.time())) -> bytes
# Generates a mobile device confirmation key for accepting trades.

Utility functions to calculate market prices including fees.

from decimal import Decimal
from steampy.utils import calculate_gross_price, calculate_net_price

# calculate_gross_price(price_net, publisher_fee, steam_fee=Decimal('0.05'))
# Returns amount buyer pays. Default steam_fee is 5%.

# calculate_net_price(price_gross, publisher_fee, steam_fee=Decimal('0.05'))
# Returns amount seller receives. Default steam_fee is 5%.

The SteamClient supports the context manager pattern (with statement). Using it ensures that login() is called upon entry and logout() is called upon exit, automatically cleaning up the session.

from steampy.client import SteamClient

with SteamClient(api_key='...', username='...', password='...', steam_guard='...') as client:
    # Perform authenticated actions
    inventory = client.get_my_inventory(game=my_game_options)
# Logout is called automatically here