Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/igeligel/TeamFortressOutpostApi

:repeat: An API wrapper for the TF2 Outpost platform. A platform to find great deals for your Team Fortress 2, Counter-Strike: Global Offensive and Dota 2 items with zero hassle.
https://github.com/igeligel/TeamFortressOutpostApi

bot bot-framework crawler steam steam-api steambot teamfortress2

Last synced: 30 days ago
JSON representation

:repeat: An API wrapper for the TF2 Outpost platform. A platform to find great deals for your Team Fortress 2, Counter-Strike: Global Offensive and Dota 2 items with zero hassle.

Awesome Lists containing this project

README

        

# TeamFortressOutpostApi by igeligel


badge Donate badge Donate badge Donate badge License



## Description

> A [.net core](https://www.microsoft.com/net/core) class library which reverse engineered the HTTP API of [TF2 Outpost](http://www.tf2outpost.com/).

## Dependencies

| Dependency | Version |
| -- | -- |
| AngleSharp | 0.9.9 |
| Newtonsoft.Json | 10.0.2 |

## Installation

To install just you need to have .net core installed.

You can install this package via nuget or locally. Try to reference it as package in your .csproj file or install it via:

```powershell
PM> Install-Package TeamFortressOutpostApi
```

or search for ``TeamFortressOutpostApi`` in your nuget feed.

## How To Use

This project just gives you one API endpoint which is usable.

First you need to create instance of the ``TeamFortressOutpostApiClient``.

```csharp
var teamFortressOutpostApiClient = new TeamFortressOutpostApiClient();
```

After this you can call a function called ``Login`` with the parameters:

- username
- password
- sharedSecret

After the function gets invoked the login process will begin and the function will return the uhash and Cookies which are needed for API requests.

## Examples
- [Official Console Example](https://github.com/igeligel/TeamFortressOutpostApi/tree/master/examples/TeamFortressOutpostApiConsole)

## Contributing

To contribute please lookup the following styleguides:

- Commits: [here](https://github.com/igeligel/contributing-template/blob/master/commits.md)
- C#: [here](https://github.com/igeligel/contributing-template/blob/master/code-style/csharp.md)

## Resources

### Motivation

Mainly i created this functionality for a friend who wanted to automate some trading at TF2 Outpost. Since i believe it is useful to someone else i decided to publish it.

### Architecture

The general Workflow is shown in this diagram:

![Workflow](http://svgur.com/i/1GR.svg)

This is the basic structure of the OpenId Login via Steam to TF2 Outpost.

## Contact


Discord server of Kevin Peters
Twitter of Kevin Peters
Steam Profile of Kevin Peters

## License

*TeamFortressOutpostApi* is realeased under the MIT License.

Contributors


igeligel

Contributions: 14

## This readme is powered by vue-readme
Check out vue-readme [[Website](https://igeligel.github.io/vue-readme) | [GitHub](https://github.com/igeligel/vue-readme)]