# steam-fetch-api

> Welcome to Steam Fetch API 👋

Latest version **0.0.19** (published 2021-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install steam-fetch-api
pnpm add steam-fetch-api
yarn add steam-fetch-api
bun add steam-fetch-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.19 |
| Published | 2021-09-03 |
| First published | 2021-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | peterculazh |
| Keywords | Steam, Steam API |

## Links

- npm: https://www.npmjs.com/package/steam-fetch-api
- Repository: https://github.com/Peterculazh/steam-fetch-api
- Homepage: https://github.com/Peterculazh/steam-fetch-api#readme
- Issues: https://github.com/Peterculazh/steam-fetch-api/issues
- npm.io page: https://npm.io/package/steam-fetch-api

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) ^6.1.0

## Recent versions

- 0.0.19 (latest) — 2021-09-03
- 0.0.18 — 2021-08-04
- 0.0.16 — 2021-08-04
- 0.0.15 — 2021-08-03

## README

<h1 align="center">Welcome to Steam Fetch API 👋</h1>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-0.0.19-blue.svg?cacheSeconds=2592000" />
  <a href="#" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
</p>

> Getting data from known Steam API.

# Install

```sh
npm install steam-fetch-api
```

## Usage example

```js
import SteamFetchAPI from 'steam-fetch-api';

const steam = new SteamFetchAPI;

const getAllGames = async () => {
  const games = await steam.getAllGames();
}
```

## Available API

- ##### Get all games without data

```js
steam.getAllGames()
```


- ##### Get game by strict name

```js
steam.getStrictByName(name: string)
```

- ##### Get list of games by name (comparing on whole game's name)

```js
steam.getListByName(name: string)
```

- ##### Get list of games by name (comparing on start game's name)

```js
steam.getListByStartName(name: string)
```

- ##### Get game with details (data from Steam Big Picture API)

```js
steam.getGameDetails(appid: number)
```

- #### Get game news. 
<strong>Max length limit not includes html tags.</strong>

```js
steam.getGameDetails(appid: number, [newsCount: number, maxLength: number])
```

### Remarks

- This package I created mostly for me. But I'm looking forward to continue develop it and improve both code and documentation;
- Steam API is not documented officially, so there poor list of endpoints that collected community. Feel free share to share it with me by creating issue;
- Currently I didn't faced request limits to Steam;



## Author

👤 **Peter Kulazhenko**

* Github: [@peterculazh](https://github.com/peterculazh)
* LinkedIn: [@peterculazh](https://linkedin.com/in/peterculazh)

## Show your support

Give a ⭐️ if this project helped you!

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

---
_Source: https://npm.io/package/steam-fetch-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._