SteamApi.Models 1.1.1

SteamApi.Models

Data transfer objects (DTOs) for Steam Web API responses.

Overview

This package provides strongly-typed models for working with Steam Web API responses. It includes models for:

• Player Information: User profiles, friends, bans, owned games
• Game Information: News, achievements, app lists
• Store Information: App details, requirements, screenshots, movies
• Response Wrappers: Standardized response structures
• Status Information: API health and configuration status

Installation

dotnet add package SteamApi.Models

Usage

These models are designed to work with the Steam Web API responses. They can be used independently or with the SteamApi.Client package.

Player Models

using SteamApi.Models.Steam.Player;
using SteamApi.Models.Steam.Responses;

// Player summary information
var player = new PlayerSummary
{
    SteamId = "76561198000000000",
    PersonaName = "PlayerName",
    ProfileUrl = "https://steamcommunity.com/profiles/76561198000000000",
    Status = PlayerStatus.Online,
    LastLogoff = 1640995200, // Unix timestamp
    TimeCreated = 1640995200  // Unix timestamp
};

// Player ban information
var bans = new PlayerBans
{
    SteamId = "76561198000000000",
    VacBanned = false,
    NumberOfVacBans = 0,
    CommunityBanned = false
};

Game Models

using SteamApi.Models.Steam.Game;
using SteamApi.Models.Steam.Responses;

// Game news
var news = new GameNews
{
    Gid = "123456",
    Title = "Game Update Released",
    Url = "https://steamcommunity.com/games/123456/news/123456",
    Author = "Developer",
    Date = DateTime.UtcNow
};

// Achievement information
var achievement = new Achievement
{
    ApiName = "ACHIEVEMENT_NAME",
    Name = "Achievement Display Name",
    Description = "Achievement description",
    Achieved = true,
    GlobalPercentage = 15.5,
    UnlockTime = 1640995200 // Unix timestamp
};

Store Models

using SteamApi.Models.Steam.Store;

// Store app details
var appDetails = new StoreAppDetails
{
    Type = "game",
    Name = "Path of Exile",
    SteamAppId = 238960,
    IsFree = true,
    ControllerSupport = "full",
    DetailedDescription = "Chris Wilson...",
    ShortDescription = "Path of Exile is an online Action RPG...",
    HeaderImage = "https://shared.akamai.steamstatic.com/...",
    Website = "http://www.pathofexile.com",
    Developers = new List<string> { "Grinding Gear Games" },
    Publishers = new List<string> { "Grinding Gear Games" }
};

// Store requirements
var requirements = new StoreRequirements
{
    Minimum = "<strong>Minimum:</strong><br>...",
    Recommended = "<strong>Recommended:</strong><br>..."
};

// Store platforms
var platforms = new StorePlatforms
{
    Windows = true,
    Mac = true,
    Linux = false
};

Response Wrappers

using SteamApi.Models.Steam.Responses;

// Wrapped response for player summaries
var response = new SteamResponse<PlayerSummariesResponse>
{
    Response = new PlayerSummariesResponse
    {
        Players = new List<PlayerSummary>
        {
            new PlayerSummary { SteamId = "76561198000000000", PersonaName = "Player1" },
            new PlayerSummary { SteamId = "76561198000000001", PersonaName = "Player2" }
        }
    }
};

Model Categories

Player Models (SteamApi.Models.Steam.Player)

• PlayerSummary - Basic user profile information
• PlayerBans - User ban information
• Friend - Friend list information
• OwnedGame - User's owned games
• RecentlyPlayedGame - Recently played games

Game Models (SteamApi.Models.Steam.Game)

• GameNews - Game news articles
• Achievement - Game achievement information
• SteamApp - Basic Steam application information

Store Models (SteamApi.Models.Steam.Store)

• StoreAppDetails - Detailed app information from Steam store
• StoreAppDetailsResponse - Store API response wrapper
• StoreRequirements - System requirements for different platforms
• StorePlatforms - Supported platforms information
• StorePackageGroup - Package and subscription information
• StoreSubscription - Individual subscription details
• StoreMetacritic - Metacritic review information
• StoreCategory - App categories
• StoreGenre - App genres
• StoreScreenshot - App screenshots
• StoreMovie - App videos and trailers
• StoreAchievements - App achievements information
• StoreReleaseDate - Release date information
• StoreSupportInfo - Support contact information
• StoreContentDescriptors - Content rating information
• StoreRating - Regional rating information

Response Models (SteamApi.Models.Steam.Responses)

• SteamResponse<T> - Generic response wrapper
• PlayerSummariesResponse - Player summaries endpoint response
• PlayerBansResponse - Player bans endpoint response
• FriendListResponse - Friend list endpoint response
• OwnedGamesResponse - Owned games endpoint response
• RecentlyPlayedGamesResponse - Recently played games endpoint response
• GameNewsResponse - Game news endpoint response
• AchievementPercentagesResponse - Achievement percentages endpoint response
• AppListResponse - App list endpoint response

Status Models (SteamApi.Models.Status)

• StatusResponse - API status information

Features

• Strongly Typed: All models are strongly typed with proper C# conventions
• XML Documentation: Full IntelliSense support with XML documentation
• Nullable Reference Types: Proper null handling with nullable reference types
• Steam API Compatible: Models match Steam Web API response structures
• Unix Timestamps: Timestamp fields use ulong to match Steam API format, epoch seconds
• Cross-Platform: Works on .NET 8+ on any platform
• No Dependencies: Zero external dependencies for maximum compatibility

Related Packages

• SteamApi.Client - HTTP client that uses these models
• Steam API Service - The .NET service that returns these models

Source Code

• GitHub Repository - Main repository
• GitLab Repository - Mirror repository

License

MIT License - see LICENSE file for details.