Steam Explorer

An API to search on Steam with extended functionalities
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   Methods
   • new SteamExplorer
   • findUsers
   • getSteamId
4. Contributing
5. License
6. Contact

About The Project

API to search on Steam Community. This is not an official Steam Application and it has no connection with Steam nor its developers

(back to top)

Built With

• 

(back to top)

Getting Started

You need to follow some steps to get this running.

Prerequisites

You need to acquire an API key from Steam. You can acquire one by filling out this form.

Installation

Install the package using your package manager of choice.

npm install steam-explorer --save

(back to top)

Usage

You may then import SteamExplorer into your project.

// ES Modules
import { SteamExplorer } from 'steam-explorer';

// CommonJS
const { SteamExplorer } = require('steam-explorer');

After that, you need to instantiate the class providing the Steam API key in the config and you're ready to use it!

const steamExplorer = new SteamExplorer({ apiKey: 'YOUR-API-KEY' });

const usersResults = await steamExplorer.findUsers('johndoe')

Methods

new SteamExplorer(config) ===> SteamExplorer object

Constructor to create a new SteamExplorer object. You need to provide a config object

1. Constructor Arguments

   • config: {SteamExplorerConfig}. Config object that contains the API key

2. Example Use

const config = {
  apiKey: 'YOUR-API-KEY'
}

const steamExplorer = new SteamExplorer(config);

findUsers(q, options) ===> Promise<FindResults<SteamUser>>

Find users in Steam Community

1. Method Arguments

   • q: {string}. Username to be searched
   • options: {FindOptions}. Search options. Default values: page = 1

2. Example Use

const config = {
  apiKey: 'YOUR-API-KEY'
}

const steamExplorer = new SteamExplorer(config);

const usersResults = await steamExplorer.findUsers('johndoe')

const moreUsersResults = await steamExplorer.findUsers('johndoe', { page: 2 })

getSteamId(nickname) ===> Promise<string>

Get the SteamId of an user from his custom url nickname https://steamcommunity.com/id/{{nickname}}

1. Method Arguments

   • nickname: {string}. Custom url nickname to be searched

2. Example Use

const config = {
  apiKey: 'YOUR-API-KEY'
}

const steamExplorer = new SteamExplorer(config);

//https://steamcommunity.com/id/johndoe12
const steamId = await steamExplorer.getSteamId('johndoe12')

---

ℹ️ More functionalities coming soon... Ideas are welcome. You can request a feature creating a new issue

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Tomas Melone - @tomzdotjs

Project Link: https://github.com/tomimelo/steam-explorer

(back to top)