https://github.com/sirh3e/steamer
Sirh3e.Steamer is a .NET wrapper library for the Steam Web API. So you can use static types.
https://github.com/sirh3e/steamer
csharp-library steamwebapi webapi
Last synced: 7 months ago
JSON representation
Sirh3e.Steamer is a .NET wrapper library for the Steam Web API. So you can use static types.
- Host: GitHub
- URL: https://github.com/sirh3e/steamer
- Owner: sirh3e
- License: bsd-3-clause
- Created: 2021-01-28T19:55:04.000Z (over 5 years ago)
- Default Branch: development
- Last Pushed: 2021-04-02T16:13:40.000Z (about 5 years ago)
- Last Synced: 2025-01-06T23:12:23.363Z (over 1 year ago)
- Topics: csharp-library, steamwebapi, webapi
- Language: C#
- Homepage:
- Size: 540 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sirh3e.Steamer
Sirh3e.Steamer is a .NET wrapper library for the Steam Web API. So you can use static types.
See [interfaces](#interfaces) for all available interfaces and methods.
## Status
| Type | Service | Status |
|-----------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| .NET Core | Github Action | [](https://github.com/sirh3e/Steamer/actions/workflows/dotnet-core.yml) |
| .NET Format | Github Action | [](https://github.com/sirh3e/Steamer/actions/workflows/dotnet-format.yml) |
| Maintainability | CODE CLIMATE | [](https://codeclimate.com/github/sirh3e/Steamer/maintainability) |
| Code Quality | CodeFactor | [](https://www.codefactor.io/repository/github/sirh3e/steamer) |
## License
[BSD-3-Clause](https://github.com/sirh3e/Steamer/blob/master/LICENSE.txt)
## Quick start
```csharp
var steamUserName = "sirh3e";
var key = "YOUR API KEY"; //Create a api key: https://steamcommunity.com/dev/apikey keep it secure
var (service, client) = SteamerWebFactory.CreateByKey(key);
//OnErr where the throw new NotImplementedException is handle the error your self :D
var steamId = (await client.SteamUser.ResolveVanityUrl
.SetVanityUrl(steamUserName)
.Build()
.ExecuteAsync(service))
.Match(response => response.Model.Map(model => model.Response.SteamId).UnwrapOrDefault(), error => throw new NotImplementedException());
```
Else have a look at: [examples](https://github.com/sirh3e/Steamer/tree/development/examples)
## Nuget
```cmd
dotnet add package Sirh3e.Steamer --version 0.1.0
```
## Interfaces
Currently implemented interfaces and methods:
- [EconService](https://partner.steamgames.com/doc/webapi/IEconService)
- CancelTradeOffer
- DeclineTradeOffer
- TradeHistory
- TradeOffer
- TradeOffers
- TradeOffersSummary
- [PlayerService](https://partner.steamgames.com/doc/webapi/IPlayerService)
- Badges
- CommunityBadgeProgress
- OwnedGames
- SteamLevel
- [SteamApps](https://partner.steamgames.com/doc/webapi/ISteamApps)
- AppList
- [SteamUser](https://partner.steamgames.com/doc/webapi/ISteamUser)
- FriendList
- PlayerBans
- PlayerSummaries
- ResolveVanityUrl
- UserGroupList
- [SteamUserStats](https://partner.steamgames.com/doc/webapi/ISteamUserStats)
- GlobalAchievementPercentagesForApp
- NumberOfCurrentPlayers
- PlayerAchievements
- SchemaForGame
- UserStatsForGame
Is a method or interface missing please create a [issue](https://github.com/sirh3e/Steamer/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BENHANCEMENT%5D)
## Semantic Versioning
Sirh3e.Steamer project strictly adhere to a [semantic](https://semver.org/) versioning scheme.
## Becoming Active in Sirh3e.Steamer development
New contributors are always welcome and I am happy to provide guidance if necessary.
## Authors
- **Plackpegasus** - *For the name Steamer* - [Plackpegasus](https://github.com/Plackpegasus)
- **SirCremefresh** - *For simplefining the examples* - [SirCremefresh](https://github.com/SirCremefresh)
- **Alexander Wyss** - *For finding a tipo* - [Alexander Wyss](https://github.com/AlexanderWyss)
- **sirh3e** - *Initial work* - [sirh3e](https://github.com/sirh3e)
See also the list of [contributors](https://github.com/sirh3e/Steamer/contributors) who participated in this project.