Skip to content

community.md

Latest commit

 

History

History
109 lines (82 loc) · 2.17 KB

community.md

File metadata and controls

109 lines (82 loc) · 2.17 KB

Community

These helpers use a logged-in Steam Community session.

Account and Profile Reads

client.get_account_info()
client.get_profile_edit_state()
client.get_profile_privacy()
client.get_community_profile_bundle()
client.get_community_session_state()

get_community_profile_bundle() is the best one-shot read when you want account info, profile edit state, and privacy data from the same page load.

Profile Edits

client.edit_profile(
    persona_name="New Name",
    custom_url="mycustomslug",
    real_name="Jayden",
    summary="Profile summary text",
    country="US",
    state="IN",
    city="123",
)

Convenience wrappers:

client.update_persona_name("New Name")
client.update_custom_url("mycustomslug")
client.update_real_name("Jayden")
client.update_summary("Profile summary text")
client.update_location(country="US", state="IN", city="123")

The single-field helpers only submit the field you asked to change. Steam sometimes replies with warning-style success: 2 payloads for profile saves, so SteamCommunityKit verifies the requested field after the write before treating the call as successful.

Privacy

Read privacy:

privacy = client.get_profile_privacy()

Write privacy:

client.set_profile_privacy(
    privacy_profile=3,
    privacy_inventory=3,
    privacy_inventory_gifts=3,
    privacy_owned_games=3,
    privacy_playtime=3,
    privacy_friends_list=3,
    comment_permission=0,
)

Shortcuts:

client.set_profile_public()
client.set_profile_private()

Avatar Upload

client.upload_avatar("avatar.png")

Trade Offer URL

trade_info = client.get_trade_offer_url()
print(trade_info["trade_url"])
print(trade_info["partner_steam_id"])
print(trade_info["token"])

Rotate the token:

new_trade_info = client.rotate_trade_offer_url()

Web API Key Page Helpers

These do not generate a key automatically. They help inspect the account state.

client.get_web_api_key_status()
client.get_web_api_key_page_state()

Useful fields include:

  • has_access
  • api_key
  • domain
  • registration_form_visible
  • revoke_available
  • reason