Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steamgriddb/node-steamgriddb
JavaScript Wrapper for the SteamGridDB API
https://github.com/steamgriddb/node-steamgriddb
api javascript steam
Last synced: 1 day ago
JSON representation
JavaScript Wrapper for the SteamGridDB API
- Host: GitHub
- URL: https://github.com/steamgriddb/node-steamgriddb
- Owner: SteamGridDB
- License: mit
- Created: 2019-06-18T19:34:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-30T13:06:38.000Z (8 months ago)
- Last Synced: 2025-01-10T09:59:05.608Z (29 days ago)
- Topics: api, javascript, steam
- Language: TypeScript
- Homepage: https://www.steamgriddb.com/api/v2
- Size: 309 KB
- Stars: 15
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SteamGridDB API
[](https://www.npmjs.com/package/steamgriddb)
[](/LICENSE.md)
[](https://discord.gg/2jYnUej)
## Installation
```bash
npm install steamgriddb
```
## Getting Started
#### Get your API key
[You can generate an API key on the preferences page.](https://www.steamgriddb.com/profile/preferences)
#### Require the library into your project.
```ts
import SGDB from "steamgriddb";
```
#### Pass your API key into the constructor:
```ts
const client = new SGDB('your_api_key');
```
Optionally, you can pass an object with some settings:
```ts
const client = new SGDB({
key: 'your_api_key',
headers: {
'X-Some-Header': 'Some Value',
},
baseURL: 'https://www.steamgriddb.com/api/v2'
});
```
## Usage
Although these code examples use [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await),
SteamGridDB can also be used with `.then()` and `.catch()`.
Example
```js
client.getGrids({type: 'game', id: 2254})
.then((grids) => {
console.log(grids);
})
.catch((error) => {
console.error(error);
});
```
### Search for a game:
```ts
const games = await client.searchGame('Half-Life 2');
```
Output
```json
[
{
"id": 2254,
"name": "Half-Life 2",
"types": [
"steam"
],
"verified": true
},
{
"id": 21207,
"name": "Half-Life",
"types": [
"steam"
],
"verified": true
},
{
"id": 1417,
"name": "Half-Life: Blue Shift",
"types": [
"steam"
],
"verified": true
},
{
"id": 3868,
"name": "Half-Life: Source",
"types": [
"steam"
],
"verified": true
}
]
```
### Get grids By Game ID
```ts
// 2254 = Game ID we got from searchGame()
const grids = await client.getGrids({type: 'game', id: 2254});
```
```ts
// 2254 = Game ID we got from searchGame()
const grids = await client.getGridsById(2254);
```
### Get grids by Steam App ID
```ts
// Get grid by Steam App Id
// 220 = https://store.steampowered.com/app/220/HalfLife_2/
const grids = await client.getGrids({type: 'steam', id: 220});
```
```ts
// 220 = https://store.steampowered.com/app/220/HalfLife_2/
const grids = await client.getGridsBySteamAppId(220);
```
### Filter styles:
```ts
const grids = await client.getGrids({type: 'game', id: 2590, styles: ['material','blurred']});
```
```ts
client.getGridsBySteamAppId(220, ['material','blurred'])
```
Output
```json
[
{
"id": 80,
"score": 1,
"style": "blurred",
"url": "https://s3.amazonaws.com/steamgriddb/grid/f033ab37c30201f73f142449d037028d.png",
"thumb": "https://s3.amazonaws.com/steamgriddb/thumb/f033ab37c30201f73f142449d037028d.png",
"tags": [],
"author": {
"name": "EpicWolverine",
"steam64": "76561198025674497",
"avatar": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/76/764911aeb96ae312c2819780f4107396d3b5ac38.jpg"
}
},
{
"id": 120,
"score": 1,
"style": "blurred",
"url": "https://s3.amazonaws.com/steamgriddb/grid/da4fb5c6e93e74d3df8527599fa62642.png",
"thumb": "https://s3.amazonaws.com/steamgriddb/thumb/da4fb5c6e93e74d3df8527599fa62642.png",
"tags": [],
"author": {
"name": "Tiederian",
"steam64": "76561197997534033",
"avatar": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/bc/bc893073b7e2e60ad412c6fd2af39d3204a5f26a.jpg"
}
}
]
```
### Delete grids:
```ts
// Delete a grid
const success = await client.deleteGrids(80);
```
```ts
// Delete multiple grids
const success = client.deleteGrids([80,81,82,83]);
```
#### Handling errors:
SteamGridDB throws an [AxiosError](https://axios-http.com/docs/handling_errors) when an error occurs, with the message
altered to contain the message returned from SteamGridDB. All methods and properties available in an AxiosError
are available, such as `error.request` and `error.response`.
```ts
// Get grids for a game that doesn't exist
let grids;
try {
grids = await SGDB.getGrids({dimensions: ["460x215", "920x430"], ...{type, id: 0}});
} catch (error) {
console.log(error.message); // "Game not found."
console.log(err.response.status); // 404
};
```
```ts
// Try to delete a grid you don't own
try {
await client.deleteGrids(34312);
} catch (error) {
console.log(error.message); // "This grid isn't yours."
console.log(err.response.status); // 403
}
```