SteamAPI

https://github.com/xdimgg/node-steamapi
Admin
A Node.js wrapper for the Steam Web API, providing methods to interact with Steam services such as...
Tokens:18,549
Snippets:51
Trust Score:8.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install SteamAPI Node.js Package

Source: https://github.com/xdimgg/node-steamapi/blob/master/README.md

This command installs the SteamAPI Node.js package using npm. Ensure you have Node.js and npm installed on your system.

```bash
npm i steamapi
```

--------------------------------

### Get App List

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves a list of all applications available on Steam. The response contains basic app information including ID and name.

```APIDOC
## GET /apps

### Description
Retrieves a list of all applications available on Steam. The response contains basic app information including ID and name.

### Method
GET

### Endpoint
/apps

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **appList** (array) - An array of objects, where each object contains basic app info (ID + name).

#### Response Example
```json
{
  "appList": [
    {
      "appid": 730,
      "name": "Counter-Strike: Global Offensive"
    },
    {
      "appid": 700,
      "name": "Half-Life"
    }
  ]
}
```
```

--------------------------------

### CacheMap Interface Methods

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/interfaces/CacheMap.md

Provides documentation for the get and set methods of the CacheMap interface.

```APIDOC
## CacheMap Interface Methods

### get()

#### Description
Retrieves a value from the cache using its key.

#### Method
N/A (Interface method)

#### Endpoint
N/A (Interface method)

#### Parameters
##### key
- **key** (K) - Required - The key of the value to retrieve.

#### Returns
- `undefined` | `V` - The cached value if found, otherwise undefined.

### set()

#### Description
Sets a value in the cache with the specified key.

#### Method
N/A (Interface method)

#### Endpoint
N/A (Interface method)

#### Parameters
##### key
- **key** (K) - Required - The key to associate with the value.
##### value
- **value** (V) - Required - The value to store in the cache.

#### Returns
- `V` - The value that was set.
```

--------------------------------

### GET /states

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Fetches a list of all states for a given country code.

```APIDOC
## GET /states

### Description
Gets all the states for a particular country.

### Method
GET

### Endpoint
`/states`

### Parameters
#### Query Parameters
- **countryCode** (string) - Required - The ISO 3166-1 alpha-2 country code (e.g., "US", "CA").

### Request Example
```json
{
  "countryCode": "US"
}
```

### Response
#### Success Response (200)
- **State** (array) - An array of state objects.
  - **countrycode** (string) - The country code.
  - **statecode** (string) - The state code.
  - **statename** (string) - The name of the state.

#### Response Example
```json
[
  {
    "countrycode": "US",
    "statecode": "CA",
    "statename": "California"
  },
  {
    "countrycode": "US",
    "statecode": "NY",
    "statename": "New York"
  }
]
```
```

--------------------------------

### GET /servers

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves information about all servers associated with a specific host.

```APIDOC
## GET /servers

### Description
Get every server associated with a particular host.

### Method
GET

### Endpoint
`/servers`

### Parameters
#### Query Parameters
- **host** (string) - Required - The host to query (IPv4 or IPv4:queryport).

### Request Example
```json
{
  "host": "192.168.1.100:27015"
}
```

### Response
#### Success Response (200)
- **Server** (array) - An array of server objects.
  - **addr** (string) - The IP address of the server.
  - **gameport** (number) - The game port of the server.
  - **specport** (number) - The spectator port of the server.
  - **steamid** (string) - The Steam ID of the server.
  - **name** (string) - The name of the server.
  - **appid** (number) - The App ID of the game running on the server.
  - **gamedata** (string) - Additional game data.
  - **map** (string) - The current map name.
  - **players** (number) - The number of players currently on the server.
  - **maxPlayers** (number) - The maximum number of players allowed on the server.
  - **bots** (number) - The number of bots on the server.
  - **ping** (number) - The ping to the server.
  - **os** (string) - The operating system of the server.
  - **dedicated** (string) - Whether the server is dedicated.
  - **gametype** (string) - The type of game.

#### Response Example
```json
[
  {
    "addr": "192.168.1.100",
    "gameport": 27015,
    "specport": 27020,
    "steamid": "12345678901234567",
    "name": "Another Server",
    "appid": 730,
    "gamedata": "",
    "map": "inferno",
    "players": 20,
    "maxPlayers": 32,
    "bots": 0,
    "ping": 30,
    "os": "l",
    "dedicated": "d",
    "gametype": "competitive"
  }
]
```
```

--------------------------------

### Get Game Details

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves detailed information for one or more game App IDs. Supports filtering by specific fields and setting currency and language. Note that requests are rate-limited and some fields like `price_overview` may be absent for Free-to-Play games.

```APIDOC
## GET /games/details

### Description
Retrieves detailed information for one or more game App IDs. Supports filtering by specific fields and setting currency and language. Note that requests are rate-limited and some fields like `price_overview` may be absent for Free-to-Play games.

### Method
GET

### Endpoint
/games/details

### Parameters
#### Query Parameters
- **app** (number | number[]) - Required - The App ID or an array of App IDs.
- **currency** (Currency) - Optional - The currency code (e.g., 'us', 'gb'). Valid codes: `us, ca, cc, es, de, fr, ru, nz, au, uk`.
- **language** (Language) - Optional - The language code for the response. See [documentation](https://www.ibabbleon.com/Steam-Supported-Languages-API-Codes.html) for valid codes.
- **filters** (string[]) - Optional - An array of strings specifying which fields to include in the response.

### Request Example
```json
{
  "example": "GET /games/details?app=730&currency=us&filters=name,price_overview"
}
```

### Response
#### Success Response (200)
- **gameDetails** (object | object[]) - If a single App ID is provided, returns a single game details object. If an array of App IDs is provided, returns a mapping of App IDs to game details objects.
  - Each game details object may contain fields such as:
    - `name` (string)
    - `steam_appid` (number)
    - `price_overview` (object) - May be absent for F2P games.
    - ... (other detailed fields)

#### Response Example
```json
{
  "730": {
    "type": "game",
    "name": "Counter-Strike 2",
    "steam_appid": 730,
    "required_age": 16,
    "is_free": false,
    "detailed_description": "...",
    "about_the_game": "...",
    "supported_languages": "English, French, German, ...",
    "reviews": "...",
    "header_image": "...",
    "website": "...",
    "pc_requirements": {
      "minimum": "...",
      "recommended": "..."
    },
    "mac_requirements": {
      "minimum": "...",
      "recommended": "..."
    },
    "linux_requirements": {
      "minimum": "...",
      "recommended": "..."
    },
    "legal_notice": "...",
    "developers": [
      "Valve"
    ],
    "publishers": [
      "Valve"
    ],
    "demos": [
      {
        "appid": 2074030,
        "discount_by_time": false
      }
    ],
    "price_overview": {
      "currency": "USD",
      "initial": 0,
      "final": 0,
      "discount_percent": 0,
      "initial_formatted": "Free to Play",
      "final_formatted": "Free to Play"
    }
  }
}
```
```

--------------------------------

### GET Request to Steam API

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

A general-purpose method to make GET requests to any Steam API endpoint.

```APIDOC
## GET /api

### Description
Used to make any GET request to the Steam API.

### Method
`GET`

### Endpoint
`/api`

### Parameters
#### Path Parameters
None

#### Query Parameters
* **path** (string) - Required - Path to request e.g '/IPlayerService/GetOwnedGames/v1?steamid=76561198378422474'
* **params** (ParsedUrlQueryInput) - Optional - Query parameters to include in the request. Defaults to `{}`.
* **base** (string) - Optional - Base URL for the API request. Defaults to the standard Steam API base URL.

### Request Example
```javascript
async function getOwnedGames(steamID) {
  const games = await steam.get('/IPlayerService/GetOwnedGames/v1', {
    steamid: steamID
  });
  return games;
}
```

### Response
#### Success Response (200)
* **any** - The parsed JSON response from the Steam API.

#### Response Example
```json
{
  "response": {
    "game_count": 123,
    "games": [
      {
        "appid": 440,
        "name": "Team Fortress 2",
        "playtime_forever": 10000,
        "playtime_two_weeks": 500
      }
    ]
  }
}
```
```

--------------------------------

### GET /appdetails

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves detailed information for one or more game App IDs. Supports filtering by currency and language, with specific limitations on supported values.

```APIDOC
## GET /appdetails

### Description
Get details for app ID(s). If an array of more than one app ID is passed in, the parameter `filters=price_overview` will be added to the request since otherwise the server would respond with null. Note: a game will not have a `price_overview` field if it is F2P. Invalid app IDs will be filtered out. Requests are limited to 200 every 5 minutes.

### Method
GET

### Endpoint
`/appdetails`

### Parameters
#### Query Parameters
- **app** (number[]) - Required - App ID or array of App IDs
- **currency** (string) - Optional - The currency. Supported values: `us, ca, cc, es, de, fr, ru, nz, au, uk`.
- **language** (string) - Optional - The language. A list of available languages can be found [here](https://www.ibabbleon.com/Steam-Supported-Languages-API-Codes.html).
- **filters** (string[]) - Optional - Fields to restrict the return results to (e.g., `price_overview`).

### Request Example
```json
{
  "app": [440, 730],
  "currency": "us",
  "language": "english"
}
```

### Response
#### Success Response (200)
- **key** (string) - The App ID.
- **GameDetails** (object) - An object containing detailed information about the game.

#### Response Example
```json
{
  "440": {
    "success": true,
    "data": { ... }
  },
  "730": {
    "success": true,
    "data": { ... }
  }
}
```
```

--------------------------------

### Get Featured Games

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves a list of featured games from the Steam store. This endpoint is undocumented and may be unstable. Supports optional currency and language parameters.

```APIDOC
## GET /featured/games

### Description
Retrieves a list of featured games from the Steam store. This endpoint is undocumented and may be unstable. Supports optional currency and language parameters.

### Method
GET

### Endpoint
/featured/games

### Parameters
#### Query Parameters
- **currency** (Currency) - Optional - The currency code (e.g., 'us', 'gb').
- **language** (Language) - Optional - The language code for the response.

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **featured** (object) - An object containing featured games.

#### Response Example
```json
{
  "featured": {
    "popular": [
      {
        "name": "Counter-Strike 2",
        "appid": 730
      }
    ],
    "current": [
      {
        "name": "Dota 2",
        "appid": 570
      }
    ]
  }
}
```
```

--------------------------------

### Get Cities

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Fetches a list of cities for a specified country and state. The returned city objects include country code, state code, city name, and city ID.

```APIDOC
## GET /cities/{countryCode}/{stateCode}

### Description
Fetches a list of cities for a specified country and state. The returned city objects include country code, state code, city name, and city ID.

### Method
GET

### Endpoint
/cities/{countryCode}/{stateCode}

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - The code of the country.
- **stateCode** (string) - Required - The code of the state within the specified country.

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **cities** (array) - An array of city objects, each with:
  - `countrycode` (string)
  - `statecode` (string)
  - `cityname` (string)
  - `cityid` (number)

#### Response Example
```json
{
  "cities": [
    {
      "countrycode": "US",
      "statecode": "CA",
      "cityname": "Los Angeles",
      "cityid": 12345
    }
  ]
}
```
```

--------------------------------

### GET /serverlist

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves a list of game servers based on the Master Server Query Protocol filter. Allows specifying a limit for the number of results.

```APIDOC
## GET /serverlist

### Description
Gets servers using the Master Server Query Protocol, allowing filtering.

### Method
GET

### Endpoint
`/serverlist`

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter as defined by the [Master Server Query Protocol](https://developer.valvesoftware.com/wiki/Master_Server_Query_Protocol#Filter). It's recommended to use filters like `appid[appid]`.
- **limit** (number) - Optional - Number of results to return. Defaults to 100.

### Request Example
```json
{
  "filter": "appid[730]",
  "limit": 50
}
```

### Response
#### Success Response (200)
- **GameServer** (array) - An array of game server objects.
  - **addr** (string) - The IP address of the server.
  - **gameport** (number) - The game port of the server.
  - **specport** (number) - The spectator port of the server.
  - **steamid** (string) - The Steam ID of the server.
  - **name** (string) - The name of the server.
  - **appid** (number) - The App ID of the game running on the server.
  - **gamedata** (string) - Additional game data.
  - **map** (string) - The current map name.
  - **players** (number) - The number of players currently on the server.
  - **maxPlayers** (number) - The maximum number of players allowed on the server.
  - **bots** (number) - The number of bots on the server.
  - **ping** (number) - The ping to the server.
  - **os** (string) - The operating system of the server.
  - **dedicated** (string) - Whether the server is dedicated.
  - **gametype** (string) - The type of game.

#### Response Example
```json
[
  {
    "addr": "123.45.67.89",
    "gameport": 27015,
    "specport": 27020,
    "steamid": "12345678901234567",
    "name": "My Awesome Server",
    "appid": 730,
    "gamedata": "",
    "map": "de_dust2",
    "players": 15,
    "maxPlayers": 32,
    "bots": 2,
    "ping": 50,
    "os": "l",
    "dedicated": "d",
    "gametype": "competitive"
  }
]
```
```

--------------------------------

### GET /schema

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Fetches the game schema for a specified App ID, including achievements and stats, in a given language.

```APIDOC
## GET /schema

### Description
Get the schema for a given App ID. This includes achievements and stats. You can specify the language for the returned strings.

### Method
GET

### Endpoint
`/schema`

### Parameters
#### Query Parameters
- **app** (number) - Required - App ID to get the schema for.
- **language** (string) - Optional - Language to return strings for (note: this parameter may not affect stats; only achievements). Defaults to English.

### Request Example
```json
{
  "app": 730,
  "language": "english"
}
```

### Response
#### Success Response (200)
- **GameSchema** (object) - An object containing the game schema.
  - **availableGameStats** (object) - An object detailing available game statistics.
    - **achievements** (array) - Array of achievement objects.
      - **name** (string) - The internal name of the achievement.
      - **defaultvalue** (number) - The default value for the achievement.
      - **displayName** (string) - The display name of the achievement.
      - **hidden** (number) - Whether the achievement is hidden (0 or 1).
      - **description** (string) - The description of the achievement.
      - **icon** (string) - The URL of the achievement icon.
    - **stats** (array) - Array of stat objects.
      - **name** (string) - The internal name of the stat.
      - **defaultvalue** (number) - The default value for the stat.
      - **displayName** (string) - The display name of the stat.

#### Response Example
```json
{
  "availableGameStats": {
    "achievements": [
      {
        "name": "ACH_WIN_ANY_LEN",
        "defaultvalue": 0,
        "displayName": "Win Round",
        "hidden": 0,
        "description": "Win a round.",
        "icon": "https://example.com/icon.png"
      }
    ],
    "stats": [
      {
        "name": "total_kills",
        "defaultvalue": 0,
        "displayName": "Total Kills"
      }
    ]
  }
}
```
```

--------------------------------

### Get Countries

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves a list of all countries supported by the API. Each country object includes its code, name, and a flag indicating if it has states.

```APIDOC
## GET /countries

### Description
Retrieves a list of all countries supported by the API. Each country object includes its code, name, and a flag indicating if it has states.

### Method
GET

### Endpoint
/countries

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **countries** (array) - An array of country objects, each with:
  - `countrycode` (string)
  - `hasstates` (boolean)
  - `countryname` (string)

#### Response Example
```json
{
  "countries": [
    {
      "countrycode": "US",
      "hasstates": true,
      "countryname": "United States"
    },
    {
      "countrycode": "GB",
      "hasstates": false,
      "countryname": "United Kingdom"
    }
  ]
}
```
```

--------------------------------

### GET /servertime

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves the current time from the Steam servers.

```APIDOC
## GET /servertime

### Description
Gets the Steam server's current time.

### Method
GET

### Endpoint
`/servertime`

### Parameters
None

### Request Example
(No request body needed)

### Response
#### Success Response (200)
- **Date** (Date object) - A JavaScript Date object representing the server's time.

#### Response Example
```json
"2023-10-27T10:30:00.000Z"
```
```

--------------------------------

### GET /players

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Retrieves the current number of players for a specific game App ID.

```APIDOC
## GET /players

### Description
Get the number of current players for a given App ID.

### Method
GET

### Endpoint
`/players`

### Parameters
#### Query Parameters
- **app** (number) - Required - App ID to get the number of current players for.

### Request Example
```json
{
  "app": 730
}
```

### Response
#### Success Response (200)
- **number** (number) - The number of current players.

#### Response Example
```json
123456
```
```

--------------------------------

### Get Featured Categories

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Fetches featured categories from the Steam store. This endpoint is undocumented and may be unstable. Supports optional currency and language parameters.

```APIDOC
## GET /featured/categories

### Description
Fetches featured categories from the Steam store. This endpoint is undocumented and may be unstable. Supports optional currency and language parameters.

### Method
GET

### Endpoint
/featured/categories

### Parameters
#### Query Parameters
- **currency** (Currency) - Optional - The currency code (e.g., 'us', 'gb').
- **language** (Language) - Optional - The language code for the response.

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **categories** (object) - An object containing featured categories.

#### Response Example
```json
{
  "categories": {
    "1": {
      "id": 1,
      "description": "Top Sellers"
    },
    "2": {
      "id": 2,
      "description": "New Releases"
    }
  }
}
```
```

--------------------------------

### GET /news

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Fetches the latest news posts for a given game App ID. Supports additional options for filtering the news feed.

```APIDOC
## GET /news

### Description
Get news for app ID. Additional options for filtering posts are available.

### Method
GET

### Endpoint
`/news`

### Parameters
#### Query Parameters
- **app** (number) - Required - App ID to get news for.
- **options** (object) - Optional - Additional options for filtering posts.
  - **maxLength** (number) - Optional - Maximum number of news items to return.
  - **filterTags** (string) - Optional - Tags to filter news by.

### Request Example
```json
{
  "app": 730,
  "options": {
    "maxLength": 5,
    "filterTags": "update"
  }
}
```

### Response
#### Success Response (200)
- **NewsPost** (array) - An array of news post objects.
  - **appID** (number) - The App ID.
  - **title** (string) - The title of the news post.
  - **url** (string) - The URL to the news post.
  - **author** (string) - The author of the news post.
  - **content** (string) - The content of the news post.
  - **date** (number) - The timestamp of the news post.
  - **feedLabel** (string) - The label of the feed.
  - **feedName** (string) - The name of the feed.
  - **isAbsoluteUrl** (boolean) - Whether the URL is absolute.
  - **commentsNumerator** (number) - The number of comments.
  - **commentCount** (number) - The total count of comments.

#### Response Example
```json
[
  {
    "appID": 730,
    "title": "Counter-Strike 2 update",
    "url": "https://store.steampowered.com/news/app/730/view/3686862777309894185",
    "author": "Steam",
    "content": "<p>Update to Counter-Strike 2...</p>",
    "date": 1695000000,
    "feedLabel": "Update",
    "feedName": "Updates",
    "isAbsoluteUrl": false,
    "commentsNumerator": 0,
    "commentCount": 0
  }
]
```
```

--------------------------------

### Get Game Achievement Percentages

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Fetches the achievement percentage for a given game App ID. Errors if the game has no achievements. The response is an array of objects, each containing the achievement name and its completion percentage.

```APIDOC
## GET /games/{appId}/achievements/percentages

### Description
Fetches the achievement percentage for a given game App ID. Errors if the game has no achievements. The response is an array of objects, each containing the achievement name and its completion percentage.

### Method
GET

### Endpoint
/games/{appId}/achievements/percentages

### Parameters
#### Path Parameters
- **appId** (number) - Required - The App ID of the game.

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **achievementPercentages** (array) - An array of objects, where each object contains:
  - `name` (string) - The name of the achievement.
  - `percent` (number) - The percentage of players who have achieved this.

#### Response Example
```json
{
  "achievementPercentages": [
    {
      "name": "First Blood",
      "percent": 95.5
    },
    {
      "name": "Deagle Master",
      "percent": 10.2
    }
  ]
}
```
```

--------------------------------

### SteamAPI Constructor

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/default.md

Initializes a new SteamAPI client with an API key and optional configurations.

```APIDOC
## Constructor

### Description
Make a new SteamAPI Client

### Method
`new SteamAPI(key, options)`

### Parameters
#### Path Parameters
* **key** (string | false) - Required - Key to use for API calls. Key can be generated at https://steamcommunity.com/dev/apikey. If you want to make requests without a key, pass in false.
* **options** (SteamAPIOptions) - Optional - Custom options for default language, HTTP parameters, and caching. Defaults to `{}`.

### Response
#### Success Response (200)
* **SteamAPI** - The initialized SteamAPI client instance.

### Request Example
```javascript
const SteamAPI = require('steamapi');
const key = 'YOUR_STEAM_API_KEY'; // or false
const steam = new SteamAPI(key, {
  language: 'en',
  விக்கும்: true
});
```
```

--------------------------------

### Server Class Documentation

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/Server.md

This section details the Server class, including its constructor and properties. The Server class represents a game server and contains information such as its address, AppID, game directory, region, and security status.

```APIDOC
## Server Class

Defined in: `structures/Server.ts:15`

Represents a game server as returned by `getServers`.

### Constructor

* **`new Server(data)`**
  * **Parameters**:
    * `data` (any): The raw data object for the server.
  * **Returns**: `Server`

### Properties

* **`id`** (string) - The SteamID of this game server.
* **`address`** (string) - Server address of the form IPv4:PORT.
* **`appID`** (number) - App ID this server is hosting.
* **`gameDir`** (string) - The directory the game is from.
* **`gmsIndex`** (number) - GMS Index. Not sure what this means.
* **`lan`** (boolean) - Is this server LAN only.
* **`port`** (number) - The port this server is running on.
* **`region`** (`ServerRegion`) - Server region.
* **`secure`** (boolean) - Is this server VAC secured.
* **`specPort`** (number) - Server specPort. Not sure what this means.
* **`reject`**? (optional string) - Requirements for clients to join server.
```

--------------------------------

### Game Class Documentation

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/Game.md

Provides details on the Game class, including its constructor, properties, and methods for accessing game information and image URLs.

```APIDOC
## Game Class

Defined in: [structures/Game.ts:4](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L4)

This class represents a game within the Steam API.

### Constructor

```typescript
new Game(data: any): Game
```

Initializes a new instance of the Game class.

#### Parameters

- **data** (any) - The data object used to construct the game instance.

#### Returns

- `Game` - A new Game instance.

### Properties

- **id** (number) - The App ID for this game. Defined in: [structures/Game.ts:6](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L6)

### Accessors

#### backgroundURL

- **get** **backgroundURL**(): `string`

Retrieves the URL for the game's background image. This might not always exist.
Defined in: [structures/Game.ts:28](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L28)

##### Returns

- `string` - The URL of the background image.

#### coverURL

- **get** **coverURL**(): `string`

Retrieves the URL for the game's cover image. This might not always exist.
Defined in: [structures/Game.ts:31](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L31)

##### Returns

- `string` - The URL of the cover image.

#### headerMediumURL

- **get** **headerMediumURL**(): `string`

Retrieves the URL for a medium-sized header image, often used on store pages. This might not always exist.
Defined in: [structures/Game.ts:16](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L16)

##### Returns

- `string` - The URL of the medium header image.

#### headerURL

- **get** **headerURL**(): `string`

Retrieves the URL for a large-sized header image, typically used on the store page. This might not always exist.
Defined in: [structures/Game.ts:13](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L13)

##### Returns

- `string` - The URL of the large header image.

#### logoURL

- **get** **logoURL**(): `string`

Retrieves the URL for the game's transparent logo. This might not always exist.
Defined in: [structures/Game.ts:34](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L34)

##### Returns

- `string` - The URL of the game logo.

#### smallHeaderURL

- **get** **smallHeaderURL**(): `string`

Retrieves the URL for a small header image, commonly used on user profile pages. This might not always exist.
Defined in: [structures/Game.ts:19](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L19)

##### Returns

- `string` - The URL of the small header image.

#### tinyHeaderURL

- **get** **tinyHeaderURL**(): `string`

Retrieves the URL for a tiny header image, often used in app bundles. This might not always exist.
Defined in: [structures/Game.ts:22](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L22)

##### Returns

- `string` - The URL of the tiny header image.
```

--------------------------------

### UserServer Constructor

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/UserServer.md

Initializes a new UserServer object with provided data. This constructor is typically used internally by the library.

```APIDOC
## UserServer Constructor

### Description
Initializes a new UserServer object.

### Method
`new UserServer(data)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **data** (any) - The raw data to construct the UserServer object from.

### Request Example
```json
{
  "data": "..."
}
```

### Response
#### Success Response (200)
* **UserServer** (UserServer) - A new instance of the UserServer class.

#### Response Example
```json
{
  "instance": "UserServer"
}
```
```

--------------------------------

### GameInfoBasic Class Documentation

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/GameInfoBasic.md

This section details the GameInfoBasic class, its constructor, properties, and inherited accessors.

```APIDOC
## Class: GameInfoBasic

### Description
Represents basic information about a game, extending the functionality of the `Game` class.

### Constructor

`new GameInfoBasic(data)`

Initializes a new instance of the `GameInfoBasic` class.

#### Parameters

* **data** (any) - The data object to initialize the game info with.

### Properties

* **icon** (string) - The hash for this game's icon.
* **id** (number) - The App ID for this game. (Inherited from `Game`)
* **name** (string) - The name of this game.

### Accessors (Inherited from `Game` unless otherwise specified)

* **backgroundURL** (string) - URL for the game's background image. (May not exist)
* **coverURL** (string) - URL for the game's cover image. (May not exist)
* **headerMediumURL** (string) - URL for a medium-sized header image.
* **headerURL** (string) - URL for a large-sized header image used on the store page.
* **iconURL** (string) - URL for the tiny app icon. (Specific to `GameInfoBasic`)
* **logoURL** (string) - URL for the game's transparent logo. (May not exist)
* **smallHeaderURL** (string) - URL for a small header image used on user pages.
* **tinyHeaderURL** (string) - URL for a tiny header image used on app bundles.
```

--------------------------------

### GameInfo Class

Source: https://github.com/xdimgg/node-steamapi/blob/master/docs/classes/GameInfo.md

This section details the GameInfo class, its constructor, properties, and inherited accessors.

```APIDOC
## Class: GameInfo

Defined in: [structures/GameInfo.ts:3](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L3)

## Constructors

### Constructor

> **new GameInfo**(`data`): `GameInfo`

Defined in: [structures/GameInfo.ts:13](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L13)

#### Parameters

##### data

- **data** (any) - 

#### Returns

- `GameInfo`

#### Overrides

- [`GameInfoBasic`](GameInfoBasic.md).[`constructor`](GameInfoBasic.md#constructor)

## Properties

### descriptorIDs?

> `optional` **descriptorIDs**: `number`[]

Defined in: [structures/GameInfo.ts:11](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L11)

Descriptor IDs. Not sure what this means. Usually undefined

***

### hasCommunityVisibleStats

> **hasCommunityVisibleStats**: `boolean`

Defined in: [structures/GameInfo.ts:5](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L5)

If this game has community visible stats

***

### hasLeaderboards

> **hasLeaderboards**: `boolean`

Defined in: [structures/GameInfo.ts:8](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfo.ts#L8)

If this game has leaderboards

***

### icon

> **icon**: `string`

Defined in: [structures/GameInfoBasic.ts:10](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoBasic.ts#L10)

Hash for this game's icon

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`icon`](GameInfoBasic.md#icon)

***

### id

> **id**: `number`

Defined in: [structures/Game.ts:6](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L6)

App ID for this game

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`id`](GameInfoBasic.md#id)

***

### name

> **name**: `string`

Defined in: [structures/GameInfoBasic.ts:7](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoBasic.ts#L7)

Name for this game

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`name`](GameInfoBasic.md#name)

## Accessors

### backgroundURL

#### Get Signature

> **get** **backgroundURL**(): `string`

Defined in: [structures/Game.ts:28](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L28)

(might not exist) game page background

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`backgroundURL`](GameInfoBasic.md#backgroundurl)

***

### coverURL

#### Get Signature

> **get** **coverURL**(): `string`

Defined in: [structures/Game.ts:31](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L31)

(might not exist) game cover

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`coverURL`](GameInfoBasic.md#coverurl)

***

### headerMediumURL

#### Get Signature

> **get** **headerMediumURL**(): `string`

Defined in: [structures/Game.ts:16](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L16)

(might not exist) medium sized header image

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`headerMediumURL`](GameInfoBasic.md#headermediumurl)

***

### headerURL

#### Get Signature

> **get** **headerURL**(): `string`

Defined in: [structures/Game.ts:13](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L13)

(might not exist) large sized header used on the store page

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`headerURL`](GameInfoBasic.md#headerurl)

***

### iconURL

#### Get Signature

> **get** **iconURL**(): `string`

Defined in: [structures/GameInfoBasic.ts:20](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/GameInfoBasic.ts#L20)

tiny app icon

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`iconURL`](GameInfoBasic.md#iconurl)

***

### logoURL

#### Get Signature

> **get** **logoURL**(): `string`

Defined in: [structures/Game.ts:34](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L34)

(might not exist) transparent game logo

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`logoURL`](GameInfoBasic.md#logourl)

***

### smallHeaderURL

#### Get Signature

> **get** **smallHeaderURL**(): `string`

Defined in: [structures/Game.ts:19](https://github.com/xDimGG/node-steamapi/blob/3e56810b4e484abde1e0f43153e48f61f57ece33/src/structures/Game.ts#L19)

(might not exist) small header image

#### Returns

- `string`

#### Inherited from

- [`GameInfoBasic`](GameInfoBasic.md).[`smallHeaderURL`](GameInfoBasic.md#smallheaderurl)

```

--------------------------------

### Initialize SteamAPI with a Token (JavaScript)

Source: https://github.com/xdimgg/node-steamapi/blob/master/README.md

This code snippet demonstrates how to initialize the SteamAPI client in JavaScript using an ES Module import. You need to replace 'steam token' with your actual Steam Web API key. This is the first step before making any API calls.

```javascript
import SteamAPI from 'steamapi';

const steam = new SteamAPI('steam token');
```
Tokens:
Raw