new CallSteamAPI() → {Object}
- Source:
Returns:
- Steam Web API Library object
- Type
- Object
Methods
(async) getFriendList(steamid, relationship, format, specificData) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
steamid |
Number | Steam ID of the user |
relationship |
String | Relationship type to retrieve |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getGlobalAchievementPercentagesForApp(gameid, format, specificData) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
gameid |
Number | Game instance ID |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getNewsForApp(appid, count, maxlength, format, specificData) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
appid |
String | App instance ID |
count |
Number | Number of news items to retrieve |
maxlength |
Number | Maximum length of each news item |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getOwnedGames(steamid, format, specificData, includeAppInfo, includePlayedFreeGames) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
steamid |
Number | Steam ID of the user |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
includeAppInfo |
Boolean | Include app information in the response |
includePlayedFreeGames |
Boolean | Include played free games in the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getPlayerAchievements(steamid, appid, format, specificData) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
steamid |
Number | Steam ID of the user |
appid |
Number | App instance ID |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getPlayerSummaries(steamids, format, specificData) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
steamids |
Number | Comma-separated list of Steam IDs |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getRecentlyPlayedGames(steamid, format, specificData, count) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
steamid |
Number | Steam ID of the user |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
count |
Number | Number of games to retrieve |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String
(async) getUserStatsForGame(steamid, appid, format, specificData) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
steamid |
Number | Steam ID of the user |
appid |
Number | App instance ID |
format |
String | Format of the data to return |
specificData |
String | Specific data to return from the response |
- Source:
Returns:
- JSON, XML, or VDF data
- Type
- String