syntax/steam-api

A steam-api client for Laravel 6+

2.3.0 2021-01-23 10:08 UTC

Requires

• php: ^7.3|^8.0
• ext-bcmath: *
• ext-curl: *
• ext-json: *
• ext-libxml: *
• ext-simplexml: *
• guzzlehttp/guzzle: ^7.0
• laravel/framework: ^6.20.12|^7.30.3|^8.22.1

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.5
• vlucas/phpdotenv: ^5.2

MIT

• Stygian

README

Version Support
Laravel >= 6.0
PHP >= 7.3.0

• Installation
• Usage
• Contributors

This package provides an easy way to get details from the Steam API service. The services it can access are:

• ISteamNews
• IPlayerService
• ISteamUser
• ISteamUserStats
• ISteamApp

Installation

Begin by installing this package with composer.

"require": {
	"syntax/steam-api": "2.3.*"
}

Next, update composer from the terminal.

composer update syntax/steam-api

Alternately, you can run "composer require syntax/steam-api:dev-master" from the command line.

Lastly, publish the config file. You can get your API key from Steam.

php artisan vendor:publish

Usage

Each service from the Steam API has its own methods you can use.

• Global
• News
• Player
• User
• User Stats
• App
• Package
• Item
• Group

Global

These are methods that are available to each service.

convertId

This will convert the given steam ID to each type of steam ID (64 bit, 32 bit and steam ID3).

Arguments

Name	Type	Description	Required	Default
id	string	The id you want to convert	Yes
format	string	The format you want back.	No	null

Possible formats are ID64, id64, 64, ID32, id32, 32, ID3, id3 and 3.

Example usage

Steam::convertId($id, $format);

Example Output: convertId

News

The Steam News web api is used to get articles for games.

Steam::news()

GetNewsForApp

This method will get the news articles for a given app ID. It has three parameters.

Arguments

Name	Type	Description	Required	Default
appId	int	The id for the app you want news on	Yes
count	int	The number of news items to return	No	5
maxlength	int	The maximum number of characters to return	No	null

Example usage

<?php
	$news = Steam::news()->GetNewsForApp($appId, 5, 500)->newsitems;
?>

Example Output: GetNewsForApp

Player

The Player Service is used to get details on players.

When instantiating the player class, you are required to pass a steamId or Steam community ID.

Steam::player($steamId)

GetSteamLevel

This method will return the level of the Steam user given. It simply returns the integer of their current level.

Example Output: GetSteamLevel

GetPlayerLevelDetails

This will return a Syntax\Containers\Player_Level object with full details for the players level.

Example Output: GetPlayerLevelDetails

GetBadges

This call will give you a list of the badges that the player currently has. There is currently no schema for badges, so all you will get is the ID and details.

Example Output: GetBadges

GetOwnedGames

GetOwnedGames returns a list of games a player owns along with some playtime information, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (i.e. the WebAPI key you are using is linked to the steamID you are requesting).

Arguments

Name	Type	Description	Required	Default
includeAppInfo	boolean	Whether or not to include game details	No	true
includePlayedFreeGames	boolean	Whether or not to include free games	No	false
appIdsFilter	array	An array of appIds. These will be the only ones returned if the user has them	No	array()

Example Output: GetOwnedGames

GetRecentlyPlayedGames

GetRecentlyPlayedGames returns a list of games a player has played in the last two weeks, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (i.e. the WebAPI key you are using is linked to the steamID you are requesting).

Arguments

Name	Type	Description	Required	Default
count	int	The number of games to return	No	null

Example Output: GetRecentlyPlayedGames

IsPlayingSharedGame

IsPlayingSharedGame returns the original owner's SteamID if a borrowing account is currently playing this game. If the game is not borrowed or the borrower currently doesn't play this game, the result is always 0.

Arguments

Name	Type	Description	Required	Default
appId	int	The game to check for	Yes

Example Output: IsPlayingSharedGame

User

The User WebAPI call is used to get details about the user specifically.

When instantiating the user class, you are required to pass at least one steamId or steam community ID.

Steam::user($steamId)

ResolveVanityURL

This will return details on the user from their display name.

Arguments

Name	Type	Description	Required	Default
displayName	string	The display name to get the steam ID for. In http://steamcommunity.com/id/gabelogannewell it would be gabelogannewell.	Yes	NULL

	$player = Steam::user($steamId)->ResolveVanityURL('gabelogannewell');

Example Output: ResolveVanityURL

GetPlayerSummaries

This will return details on one or more users.

Arguments

Name	Type	Description	Required	Default
steamId	int[]	An array of (or singular) steam ID(s) to get details for	No	Steam ID passed to user()

	// One user
	$steamId = 76561197960287930;
	$player = Steam::user($steamId)->GetPlayerSummaries()[0];
	
	// Several users
	$steamIds = [76561197960287930, 76561197968575517]
	$players = Steam::user($steamIds)->GetPlayerSummaries();

Example Output: GetPlayerSummaries

GetFriendList

Returns the friend list of any Steam user, provided his Steam Community profile visibility is set to "Public".

Arguments

Name	Type	Description	Required	Default
relationship	string (all or friend)	The type of friends to get	No	all
summaries	bool (true or false)	To return the friend player summaries, or only steamIds	No	true

Once the list of friends is gathered, if summaries is not set to false; it is passed through GetPlayerSummaries. This allows you to get back a collection of Player objects.

Example Output: GetFriendList

GetPlayerBans

Returns the possible bans placed on the provided steam ID(s).

Arguments

Name	Type	Description	Required	Default
steamId	int[]	An array of (or singular) steam id(s) to get details for	No	Steam id passed to user()

Example Output: GetPlayerBans

User Stats

The User Stats WebAPI call is used to get details about a user's gaming.

When instantiating the user stats class, you are required to pass a steamID or Steam community ID.

Steam::userStats($steamId)

GetPlayerAchievements

Returns a list of achievements for this user by app ID.

Arguments

Name	Type	Description	Required	Default
appId	int	The id of the game you want the user's achievements in	Yes

Example Output: GetPlayerAchievements

GetGlobalAchievementPercentagesForApp

This method will return a list of all achievements for the specified game and the percentage of all users that have unlocked each achievement.

Arguments

Name	Type	Description	Required	Default
appId	int	The ID of the game you want the user's achievements in	Yes

Example Output: GetGlobalAchievementPercentagesForApp

GetUserStatsForGame

Returns a list of achievements for this user by app ID.

Arguments

Name	Type	Description	Required	Default
appId	int	The ID of the game you want the user's achievements in	Yes
all	boolean	If you want all stats and not just the achievements set to true.	No	FALSE

Example Output: GetUserStatsForGame | GetUserStatsForGame (all)

GetSchemaForGame

Returns a list of game details, including achievements and stats.

Arguments

Name	Type	Description	Required	Default
appId	int	The ID of the game you want the details for.	Yes

Example Output: GetSchemaForGame

App

This area will get details for games.

Steam::app()

appDetails

This gets all the details for a game. This is most of the information from the store page of a game.

Arguments

Name	Type	Description	Required	Default
appIds	int[]	The ids of the games you want details for	Yes
cc	string	The cc is the country code, you can get appropriate currency values according to ISO 3166-1	No
l	string	The l is the language parameter, you can get the appropriate language according to ISO 639-1	No

Example Output: appDetails

GetAppList

This method will return an array of app objects directly from Steam. It includes the appID and the app name.

Example Output: GetAppList

Package

This method will get details for packages.

Steam::package()

packageDetails

This gets all the details for a package. This is most of the information from the store page of a package.

Arguments

Name	Type	Description	Required	Default
packIds	int[]	The ids of the packages you want details for	Yes
cc	string	The cc is the country code, you can get appropriate currency values according to ISO 3166-1	No
l	string	The l is the language parameter, you can get the appropriate language according to ISO 639-1 (If there is one)	No

Example Output: packageDetails

Item

This method will get user inventory for item.

Steam::item()

GetPlayerItems

This gets all the item for a user inventory.

Arguments

Name	Type	Description	Required	Default
appId	int	The appid of the game you want for	Yes
steamid	int	The steamid of the Steam user you want for	Yes

⚠️ Now known to supports:440, 570, 620, 730, 205790, 221540, 238460

Example Output: GetPlayerItems

Group

This service is used to get details on a Steam group.

Steam::group()

GetGroupSummary

This method will get the details for a group.

Arguments

Name	Type	Description	Required	Default
group	string or int	The ID or the name of the group.	Yes

Example usage

<?php
	$news = Steam::group()->GetGroupSummary('Valve');
?>

Example Output: GetGroupSummary

Testing the Steam Package

A Steam API key must be provided or most tests will fail.

Run Tests

# Install dependancies
docker-compose run php composer install

# Run tests (assumes apiKey is set in .env file)
docker-compose run php composer test

# Or with the apiKey inline
docker-compose run -e api=YOUR_STEAM_API_KEY php composer test

# With coverage
docker-compose run php composer coverage

# Play around
docker-compose run php bash

Contributors

• Stygiansabyss
• nicekiwi
• rannmann
• Amegatron
• mjmarianetti
• MaartenStaa
• JRizzle88
• jastend
• Teakowa
• Ben Sherred