Endpoints

Endpoint Reference

TeemoCell\SteamWebApi\Client exposes typed factories for the supported Steam services. Select a service for method signatures, requirements and examples.

Client factory	Interface or source	Documentation
$steam->news()	ISteamNews	News
$steam->player($steamId)	IPlayerService	Player service
$steam->user($steamId)	ISteamUser	Steam user
$steam->userStats($steamId)	ISteamUserStats	User stats
$steam->app() / $steam->package()	IStoreService and Store endpoints	Store service
$steam->workshop()	IPublishedFileService	Workshop
$steam->webApi()	ISteamWebAPIUtil	Web API utilities
$steam->gameServers()	IGameServersService	Game servers
$steam->publisher()	Publisher-only Steamworks methods	Publisher API

Legacy Community XML and inventory methods are documented under Legacy and deprecated methods.

Common setup

use TeemoCell\SteamWebApi\Client;

$steam = new Client(apiKey: $_ENV['STEAM_API_KEY']);

All endpoint clients reuse the API key and HTTP client from the root client. See Configuration to inject a custom Guzzle client.

Access considerations

• Profile privacy affects friends, games, playtime and achievements.
• Some app-specific data requires a key associated with that app.
• Publisher endpoints require a publisher key and a trusted server.
• Game-server methods may require appropriate Steamworks permissions.
• Legacy Store and Community endpoints can change independently of documented Steamworks interfaces.