Skip to main content

Module types

Module types 

Source
Expand description

Type definitions for Steam Community operations.

Re-exports§

pub use apps::AppDetail;
pub use apps::AppListItem;
pub use apps::AppPriceOverview;
pub use apps::Category;
pub use apps::CooldownInfo;
pub use apps::CsgoAccountStats;
pub use apps::DynamicStoreUserData;
pub use apps::LastPlayedMode;
pub use apps::MatchmakingPerMap;
pub use apps::MatchmakingStats;
pub use apps::MatchmakingSummary;
pub use apps::OwnedApp;
pub use apps::OwnedAppDetail;
pub use apps::Platforms;
pub use apps::ReleaseDate;
pub use apps::SimpleSteamAppList;
pub use apps::SteamAppVersionInfo;
pub use file_upload::BeginFileUploadResult;
pub use file_upload::CommitFileDetails;
pub use file_upload::CommitFileUploadParams;
pub use file_upload::CommitFileUploadResponse;
pub use file_upload::CommitFileUploadResult;
pub use file_upload::RequestHeader;
pub use ids::Amount;
pub use ids::AppId;
pub use ids::AssetId;
pub use ids::ClassId;
pub use ids::ContextId;
pub use ids::InstanceId;
pub use ids::ItemNameId;
pub use ids::PriceCents;
pub use ids::TradeOfferId;
pub use gameplay::FriendsGameplayInfo;
pub use gameplay::GameplayInfoResponse;
pub use gameplay::OwnGameplayInfo;
pub use match_history::Match;
pub use match_history::MatchHistoryResponse;
pub use match_history::MatchHistoryType;
pub use match_history::MatchPlayer;
pub use match_history::Team;
pub use notifications::Notifications;

Modules§

apps
file_upload
gameplay
ids
Type-safe newtypes for Steam economy identifiers.
match_history
Match history types for CS:GO/CS2 match data.
notifications

Structs§

AccountDetails
Full account details parsed from https://store.steampowered.com/account/authorizeddevices.
AccountRecoveryStatus
Status from polling account recovery confirmation.
ActiveInventory
Represents an app that has items in the user’s inventory.
ActivityAchievement
An achievement earned in an activity.
ActivityApp
An app/game reference in an activity.
ActivityAuthor
Author of an activity (for game purchases, etc.).
ActivityComment
A comment on an activity item.
ActivityCommentResponse
Response from commenting/rating an activity.
ActivityGroup
A group reference in an activity.
ActivityPlayer
A player reference in an activity.
AddPhoneNumberResponse
Response from adding a phone number.
AliasEntry
A user’s alias history entry.
AssetProperties
Top-level asset properties object from the API response.
AssetPropertyEntry
An asset property entry from the asset_properties array.
AuthorizedDevice
A single authorized Steam device / active session.
AvatarHistoryEntry
Entry in a user’s avatar history.
AvatarUploadResponse
Response from an avatar upload.
BoosterPackEntry
Booster pack catalog entry.
BoosterResult
Result of creating a booster pack.
BroadcastUser
Broadcast status for the logged-in user (data-broadcastuser).
CommentAuthor
Author of a comment.
CommunitySearchPlayer
A player found in community search.
CommunitySearchResult
Result of a community search.
ConfirmEmailResponse
Response from confirming new email with OTP.
ConfirmPhoneCodeResponse
Confirmation
A mobile confirmation requiring user action.
DeviceIp
IPv4/v6 address for a device location entry.
DeviceLocation
Geographic + time info for a device first/last-seen event.
EconItem
An item in a Steam inventory (merged asset + description).
FriendActivity
A single activity item from the friend activity feed.
FriendActivityResponse
Response from getting the friend activity feed.
FriendDetails
Details of a Steam friend.
FriendListPage
Result of fetching a friend/following list page.
FriendPageInfo
Metadata parsed from a Steam friend/following page.
GameBanData
GemResult
Result of turning an item into gems.
GemValue
Result of checking an item’s gem value.
GroupAnnouncement
A group announcement.
GroupComment
A group comment.
GroupEvent
A group event.
GroupHistoryEntry
Group history entry.
GroupInfo
Information about a Steam group.
GroupInfoXml
Group information from XML API (memberslistxml endpoint).
GroupOverview
Detailed overview of a Steam group.
GroupOverviewMember
A member in a group overview.
GroupOverviewOptions
Options for fetching group overview.
HelpRequest
Represents a Steam Help Request (Support Ticket).
InventoryAction
An action link for an inventory item (e.g. “Inspect in Game…”).
InventoryApiTag
A tag on an inventory item from the Steam API.
InventoryAsset
A single asset entry from the Steam inventory API response.
InventoryCursor
Cursor for paginating inventory history.
InventoryDescription
A full description object from the Steam inventory API response.
InventoryDescriptionEntry
A sub-description entry within an InventoryDescription.
InventoryHistoryItem
A row in the inventory history.
InventoryHistoryResult
Result of fetching inventory history.
InventoryResponse
The full inventory API response from Steam.
InvitableGroup
A group that a user can be invited to.
ItemOrdersHistogramResponse
Response from item orders histogram API.
LoggedInResult
Return type for [SteamUserApi::logged_in].
MarketHistoryListing
A market history listing entry.
MarketHistoryResponse
Response for market history request.
MarketItem
A market listing item.
MarketListing
A Steam Market listing.
MarketRestrictions
Market restriction information.
MyListingsResult
Return type for [SteamUserApi::get_my_listings].
PageConfig
Store page configuration block (data-config).
PageHwInfo
Hardware / client-type flags embedded in the page.
PageNotification
A single Steam notification embedded in the page.
PageNotifications
Notification list and pending-count data from data-steam_notifications.
PageUserInfo
Basic account / session info embedded in every Steam Store page.
ParsedTradeURL
Information extracted from a trade offer URL.
PendingFriend
A pending friend request (incoming or outgoing).
PendingFriendList
Result of get_pending_friend_list.
PlayerReport
Represents a player report.
PriceOverview
Price overview for a market item.
PrivacySettings
Privacy settings for profile elements.
ProfileSettings
Profile editing settings.
PublicProfileSummary
Snapshot of a Steam profile as returned by the public steamcommunity.com/id/{vanity}/?xml=1 (or /profiles/{id}/?xml=1) feed.
PurchaseHistoryItem
A single purchase history item from the Steam account history.
QuickInviteData
Data for a quick invite link.
QuickInviteToken
A single quick invite token.
QuickInviteTokensResponse
Response containing all of a user’s quick invite tokens.
RedeemWalletCodeResponse
Response from redeeming a Steam wallet code.
RemovePhoneResult
SellItemResult
Result of a sell item operation.
SendRecoveryCodeResponse
Response from sending account recovery code.
SteamProfile
Parsed profile information.
SteamUserProfile
Lightweight profile information returned by resolve_users.
StoreUserConfig
Store-side user config block (data-store_user_config).
SubmitEmailResponse
Response from submitting a new email.
TradeOffer
A Steam trade offer.
TradeOfferAsset
An asset being offered or requested in a new trade offer.
TradeOfferItem
A single item within a trade offer summary.
TradeOfferItems
Container for assets belonging to one side of a trade.
TradeOfferPartner
Trading partner details in a trade offer.
TradeOfferResult
Result of sending a trade offer.
TradeOfferSummary
Summary information for a category of trade offers.
TradeOffersResponse
Response containing trade offers summary and active offers.
TradePeople
Trading partner in inventory history.
TransactionId
Transaction ID wrapper
TwoFactorResponse
Response from enabling two-factor authentication.
TwoFactorStatus
Two-factor / Steam Guard status for the account.
TwoFactorUsage
A single two-factor authenticator usage record.
UserComment
A comment on a user’s profile.
UserSummaryProfile
User summary from HTML profile page (parsed).
UserSummaryXml
User summary from XML profile endpoint (/profiles/{steamid}/?xml=1).
WalletBalance
Wallet balance information.
WizardDefaultParams
Default wizard parameters extracted from JavaScript.
WizardIssue
Issue-specific form fields for the wizard.
WizardPageParams
Parsed wizard page parameters from Steam Help pages.

Enums§

ActivityType
Type of activity in the friend activity feed.
BanStatus
ChangeEmailResult
Result of an email change operation.
ConfirmationType
Type of confirmation.
OnlineState
Steam Community online state, as reported by the public profile XML.
PrivacyState
Privacy state for profile elements.
SteamGuardStatus
Steam Guard status.
TradeBanState
Trade-ban status reported by Steam.
TradeOfferStatus
Status of a trade offer, derived from the HTML banner class and text.