steam-webapi-rust-sdk

Crates.iosteam-webapi-rust-sdk
lib.rssteam-webapi-rust-sdk
version0.0.8
sourcesrc
created_at2022-08-01 19:28:25.647438
updated_at2022-12-25 11:49:21.46226
descriptionSet of utility functions to access Steam Web API
homepagehttps://github.com/bohdaq/steam-webapi-rust-sdk
repositoryhttps://github.com/bohdaq/steam-webapi-rust-sdk
max_upload_size
id637017
size152,306
Bohdan Tsap (bohdaq)

documentation

README

Welcome to steam-webapi-rust-sdk!

Hi, steam-webapi-rust-sdk is a set of utility functions to access Steam Web API.

In order to use this library make sure to set STEAM_WEB_API_KEY system environment variable.

The library itself tries to minimize number of networks calls through the caching relevant responses to the 'steam-webapi-cache' folder.

There is already prebuilt cache for all steam apps, in order to use it, simply download and extract steam-webapi-cache into the root folder of your project. You can check integrity of the package by provided sha256 checksum.

Features

  1. Ability to get list of apps available on the Steam

  2. Ability to get detailed app description from Steam

  3. Ability to retrieve list of Dota2 matches

  4. Local cache of the app details

Configuration

In order to use this library make sure to set STEAM_WEB_API_KEY system environment variable.

$ vim ~/.bash_profile

export STEAM_WEBAPI_KEY="YOUR_STEAM_WEBAPI_KEY"

$ source ~/.bash_profile

Demo

App to retrieve details for all apps available on Steam store.

App to list all properties in app details response API on Steam store.

App shows how to use steam-webapi-rust-sdk to retrieve list of Dota2 matches

Documentation

Public functions definitions and usage can be found at cargo docs.

Build

If you want to build steam-webapi-rust-sdk on your own, make sure you have Rust installed.

$ cargo build

Test

If you want to test steam-webapi-rust-sdk. You need to be connected to the internet as some of the tests invoke Steam API.

$ cargo test

Community

Contact me on Discord where you can ask questions and share ideas. Follow the Rust code of conduct.

Donations

If you appreciate my work and want to support it, feel free to do it via PayPal.

Commit count: 160

cargo fmt