https://github.com/tomimelo/steam-explorer
An API to search on Steam
https://github.com/tomimelo/steam-explorer
Last synced: about 1 year ago
JSON representation
An API to search on Steam
- Host: GitHub
- URL: https://github.com/tomimelo/steam-explorer
- Owner: tomimelo
- License: mit
- Created: 2022-10-25T22:00:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-08T12:50:07.000Z (over 3 years ago)
- Last Synced: 2025-03-15T03:06:56.185Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/steam-explorer
- Size: 238 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Steam Explorer
An API to search on Steam with extended functionalities
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
# 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
## Built With
* [![Node][Node.js]][Node-url]
# 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](https://steamcommunity.com/dev/apikey).
## Installation
Install the package using your package manager of choice.
```sh
npm install steam-explorer --save
```
# Usage
You may then import `SteamExplorer` into your project.
```js
// 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!
```js
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
```js
const config = {
apiKey: 'YOUR-API-KEY'
}
const steamExplorer = new SteamExplorer(config);
```
### `findUsers(q, options) ===> Promise>`
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
```js
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`
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
```js
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
# License
Distributed under the MIT License. See `LICENSE.txt` for more information.
# Contact
Tomas Melone - [@tomzdotjs](https://twitter.com/tomzdotjs)
Project Link: [https://github.com/tomimelo/steam-explorer](https://github.com/tomimelo/steam-explorer)
[contributors-shield]: https://img.shields.io/github/contributors/tomimelo/steam-explorer.svg?style=for-the-badge
[contributors-url]: https://github.com/tomimelo/steam-explorer/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/tomimelo/steam-explorer.svg?style=for-the-badge
[forks-url]: https://github.com/tomimelo/steam-explorer/network/members
[stars-shield]: https://img.shields.io/github/stars/tomimelo/steam-explorer.svg?style=for-the-badge
[stars-url]: https://github.com/tomimelo/steam-explorer/stargazers
[issues-shield]: https://img.shields.io/github/issues/tomimelo/steam-explorer.svg?style=for-the-badge
[issues-url]: https://github.com/tomimelo/steam-explorer/issues
[license-shield]: https://img.shields.io/github/license/tomimelo/steam-explorer.svg?style=for-the-badge
[license-url]: https://github.com/tomimelo/steam-explorer/blob/master/LICENSE.txt
[Node.js]: https://img.shields.io/badge/-Node.js-3C873A?style=for-the-badge&logo=Node.js&logoColor=white
[Node-url]: https://nodejs.org/