PHPackages                             jocolopes/steamapi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jocolopes/steamapi

ActiveLibrary[API Development](/categories/api)

jocolopes/steamapi
==================

Steam Web Api Generic Integration

141.4k8[1 issues](https://github.com/DPr00f/steam-web-api-php/issues)[2 PRs](https://github.com/DPr00f/steam-web-api-php/pulls)PHP

Since Jan 25Pushed 7y ago2 watchersCompare

[ Source](https://github.com/DPr00f/steam-web-api-php)[ Packagist](https://packagist.org/packages/jocolopes/steamapi)[ RSS](/packages/jocolopes-steamapi/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (1)Used By (0)

[![wercker status](https://camo.githubusercontent.com/d5ecb0fc05b9b2e11259263ae59b68c18378253b9651282a5891c25e824307d1/68747470733a2f2f6170702e776572636b65722e636f6d2f7374617475732f62323630306232643737623864333566303836663635353466343032373339632f6d2f6d6173746572 "wercker status")](https://app.wercker.com/project/bykey/b2600b2d77b8d35f086f6554f402739c)

About
=====

[](#about)

PHP Wrapper to communicate with Steam Web API

SteamID64 Finder
================

[](#steamid64-finder)

Please refer to  or  to find the user steam id.

Install
=======

[](#install)

Add to your composer.json

```
{
    "require": {
        "jocolopes/steamapi": "dev-master"
    }
}

```

Usage
=====

[](#usage)

User Class
----------

[](#user-class)

```
$user = new \SteamApi\User('YOUR-STEAM-KEY', 'THE-STEAMID64');

```

#### Get Player Bans

[](#get-player-bans)

```
$user->GetPlayerBans();
// OR
$user->GetPlayerBans('THE-FIRST-STEAMID64,THE-SECOND-STEAMID64,THE-ANY-STEAMID64');

```

#### Get Player Summaries

[](#get-player-summaries)

```
$user->GetPlayerSummaries();
// OR
$user->GetPlayerSummaries('THE-FIRST-STEAMID64,THE-SECOND-STEAMID64,THE-ANY-STEAMID64');

```

#### Get Friend List

[](#get-friend-list)

```
$user->GetFriendList();

```

#### Get UserGroup List

[](#get-usergroup-list)

```
$user->GetUserGroupList();

```

#### ResolveVanityUrl

[](#resolvevanityurl)

```
$user->ResolveVanityUrl('id-of-user-to-translate-into-steam-id');
// Example
$user->ResolveVanityUrl('pr00fgames'); // Result: 76561197963455129

```

Player Class
------------

[](#player-class)

```
$player = new \SteamApi\Player('YOUR-STEAM-KEY', 'THE-STEAMID64');

```

#### Get Steam Level

[](#get-steam-level)

```
$player->GetSteamLevel();

```

#### Get Player Level Details

[](#get-player-level-details)

```
$player->GetPlayerLevelDetails();

```

#### Get Badges

[](#get-badges)

```
$player->GetBadges();

```

#### Get Community Badge Progress

[](#get-community-badge-progress)

```
$player->GetCommunityBadgeProgress();

```

#### Get Owned Games

[](#get-owned-games)

```
$player->GetOwnedGames();

```

#### Get Recently Played Games

[](#get-recently-played-games)

```
$player->GetRecentlyPlayedGames();

```

#### Is Playing Shared Game

[](#is-playing-shared-game)

```
$player->IsPlayingSharedGame($gameId);

```

News Class
----------

[](#news-class)

```
$news = new \SteamApi\News('YOUR-STEAM-KEY');

```

#### Get News For App

[](#get-news-for-app)

```
$news->GetNewsForApp($appId[, $numberOfNews, $maxLength]); // Last 2 arguments are optional

```

App Class
---------

[](#app-class)

```
$app = new \SteamApi\App('YOUR-STEAM-KEY');

```

#### Get App Details

[](#get-app-details)

```
$app->appDetails($appId);

```

#### Get Servers At Address

[](#get-servers-at-address)

```
$app->GetServersAtAddress($address); // Hostname or IP:Port

```

#### Get App List

[](#get-app-list)

```
$app->GetAppList();

```

#### Check for up to date application

[](#check-for-up-to-date-application)

```
$app->UpToDateCheck($appId, $appVersion);

```

User Stats
----------

[](#user-stats)

```
$stats = new Stats('YOUR-STEAM-KEY', 'THE-STEAMID64');

```

#### Get Global Stats For Game

[](#get-global-stats-for-game)

```
$stats->GetGlobalStatsForGame($gameId, array('STATS-NAME'));
// Example
$stats->GetGlobalStatsForGame(17740, array('global.map.emp_isle'));

```

#### Get Number Of Current Players

[](#get-number-of-current-players)

```
$stats->GetNumberOfCurrentPlayers($appId);

```

#### Get Schema For Game

[](#get-schema-for-game)

```
$stats->GetSchemaForGame($appId);

```

#### Get Player Achievements

[](#get-player-achievements)

```
$stats->GetPlayerAchievements($appId);

```

#### Get Global Achievement Percentages For App

[](#get-global-achievement-percentages-for-app)

```
$stats->GetGlobalAchievementPercentagesForApp($appId);

```

#### Get User Stats Fo rGame

[](#get-user-stats-fo-rgame)

```
$stats->GetUserStatsForGame($appId);

```

More Info
=========

[](#more-info)

Please Refer to the tests folder to get more information on how to use the library

Objective
=========

[](#objective)

The objective of this library is to wrap the steam web API into a php object.

There are some missing methods that I plan to implement soon.

Feel free to add some missing methods and as for a pull request on this repo.

The missing methods can be found using the [swissapiknife](https://github.com/Lagg/steam-swissapiknife).

FAQ
===

[](#faq)

Do I need anything special to use this library?
-----------------------------------------------

[](#do-i-need-anything-special-to-use-this-library)

You do need PHP 5.4+ and composer. You also need to load the `vendor/autoload.php` into your project.

Will this work on my framework?
-------------------------------

[](#will-this-work-on-my-framework)

This library is framework agnostic, maybe the framework you're using requires some aditional setup.

If your framework uses composer you should be good to go. But let me know if you run into any troubles.

Found a bug, what should I do?
------------------------------

[](#found-a-bug-what-should-i-do)

If you have the capacity to fix it yourself by all means do and create a pull request.

If you don't, raise an issue on github and me or someone else will try to fix it.

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/989959?v=4)[Joao Lopes](/maintainers/DPr00f)[@DPr00f](https://github.com/DPr00f)

---

Top Contributors

[![DPr00f](https://avatars.githubusercontent.com/u/989959?v=4)](https://github.com/DPr00f "DPr00f (16 commits)")

### Embed Badge

![Health badge](/badges/jocolopes-steamapi/health.svg)

```
[![Health](https://phpackages.com/badges/jocolopes-steamapi/health.svg)](https://phpackages.com/packages/jocolopes-steamapi)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
