steam-fetch-api
TypeScript icon, indicating that this package has built-in type declarations

0.0.19ย โ€ขย Publicย โ€ขย Published

Welcome to Steam Fetch API ๐Ÿ‘‹

Version License: MIT

Getting data from known Steam API.

Install

npm install steam-fetch-api

Usage example

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
steam.getAllGames()
  • Get game by strict name
steam.getStrictByName(name: string)
  • Get list of games by name (comparing on whole game's name)
steam.getListByName(name: string)
  • Get list of games by name (comparing on start game's name)
steam.getListByStartName(name: string)
  • Get game with details (data from Steam Big Picture API)
steam.getGameDetails(appid: number)
  • Get game news.

Max length limit not includes html tags.

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

Show your support

Give a โญ๏ธ if this project helped you!


This README was generated with โค๏ธ by readme-md-generator

Readme

Keywords

Package Sidebar

Install

npm i steam-fetch-api

Weekly Downloads

3

Version

0.0.19

License

MIT

Unpacked Size

20.4 kB

Total Files

18

Last publish

Collaborators

  • peterculazh