{"id":21496348,"url":"https://github.com/thunbergolle/web-api-steam","last_synced_at":"2025-03-17T12:15:45.078Z","repository":{"id":57152661,"uuid":"139272732","full_name":"ThunbergOlle/web-api-steam","owner":"ThunbergOlle","description":"Everything you need with working with the steam web api","archived":false,"fork":false,"pushed_at":"2018-07-16T11:29:27.000Z","size":1214,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-24T12:49:11.506Z","etag":null,"topics":["api-steamstore","csgo","steam","steam-api","steam-module","steam-web","web"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ThunbergOlle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-30T18:57:45.000Z","updated_at":"2021-09-03T16:20:37.000Z","dependencies_parsed_at":"2022-09-06T18:10:50.977Z","dependency_job_id":null,"html_url":"https://github.com/ThunbergOlle/web-api-steam","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThunbergOlle%2Fweb-api-steam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThunbergOlle%2Fweb-api-steam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThunbergOlle%2Fweb-api-steam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThunbergOlle%2Fweb-api-steam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThunbergOlle","download_url":"https://codeload.github.com/ThunbergOlle/web-api-steam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244031154,"owners_count":20386534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-steamstore","csgo","steam","steam-api","steam-module","steam-web","web"],"created_at":"2024-11-23T16:15:52.695Z","updated_at":"2025-03-17T12:15:45.052Z","avatar_url":"https://github.com/ThunbergOlle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steams Web Api in a module\nHere is everything you need for interacting with the steams web api.\nBefore you begin using this we recommend getting the [apikey](https://steamcommunity.com/dev/apikey) right away. If you don't have one you will not be able to use some of the functions.\n\n**Contribute:** [Github Rep](https://github.com/ThunbergOlle/web-api-steam)\n\n**Install**\n```js\nnpm install web-api-steam --save\n```\n**Import**\n```js\nconst SteamApi = require('web-api-steam');\n```\n\n## Methods\n```js\nSteamApi.getFriendList(steam64id, key, (err, data) =\u003e {})\n```\n- steam64id: This is the steam64id of the user that you want to get the inventory from. Use a string value.\n- key: This is the apikey\nBetter docs and readme file will be added soon!\n- callback: Callback function.\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n```js\nSteamApi.getPlayerInfo(steam64id, key, (err, data) =\u003e {})\n```\n- steam64id: This is the steam64id of the user that you want to get the inventory from. Use a string value.\n- key: This is the apikey\nBetter docs and readme file will be added soon!\n- callback: Callback function.\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n```js\nSteamApi.getGAchievements(appid, (err, data) =\u003e {})\n```   \n- appid: The appid you want to get the global achievements for\n- callback: Callback function\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n```js\nSteamApi.getPlayerBans(steam64id, apikey, (err, data) =\u003e {})\n```   \n- steam64id: The steam64id of the user you want to check bans on.\n- apikey: The required apikey.\n- callback: Callback function\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n```js\nSteamApi.getOwnedGames(steam64id, apikey, (err, data) =\u003e {})\n```\n- steam64id: The steam64id of the user you want to check bans on.\n- apikey: The required apikey.\n- callback: Callback function\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n```js\nSteamApi.getSchema(appid, apikey, (err, data) =\u003e {})\n```\n- appid: The appid you want to check it for.\n- apikey: The required apikey.\n- callback: Callback function\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n```js\nSteamApi.getUserStats(appid, steam64id, apikey, (err, data) =\u003e {})\n```\n- appid: The appid you want to check it for.\n- steam64id: The steam64id you want to check the user stats on.\n- apikey: The required apikey.\n- callback: Callback function\n    - err: If there are any errors here they will be!\n    - data: The data received\n\n### Examples in JS format\nHere you will be able to find examples.\n#### Get Player Bans\n```js\nSteamApi.getPlayerBans('76561198089544929', 'your_api_key', (err, data) =\u003e {\n    if(err) throw err;\n    console.log(data);\n})\n\n```\n**Output**\n```js\n{ SteamId: '76561198089544929',\n  CommunityBanned: false,\n  VACBanned: false,\n  NumberOfVACBans: 0,\n  DaysSinceLastBan: 0,\n  NumberOfGameBans: 0,\n  EconomyBan: 'none' }\n```\n---\n#### Get Friendlist of player\n```js\nSteamApi.getFriendList('76561198089544929', 'your_api_key', (err, data) =\u003e {\n    if(err) throw err;\n    console.log(data);\n});\n```\n**Output**\n```js\n[ { steamid: '76561197963343887',\n    relationship: 'friend',\n    friend_since: 1517122708 },\n  { steamid: '76561197969200720',\n    relationship: 'friend',\n    friend_since: 1457710832 },\n  { steamid: '76561197986015023',\n    relationship: 'friend'}\n    ]\n```\n---\n#### Get Global achievements stats for a game\n```js\nSteamApi.getGAchievements('730', (err, data) =\u003e {\n    if(err) throw err;\n    console.log(data);\n});\n```\n**Output**\n```js\n[ { name: [ 'KILL_ENEMY_RELOADING' ],\n    percent: [ '78.5999984741210938' ] },\n  { name: [ 'GIVE_DAMAGE_LOW' ],\n    percent: [ '78.5999984741210938' ] },\n  { name: [ 'UNSTOPPABLE_FORCE' ], percent: [ '77.5' ] },\n  { name: [ 'KILL_ENEMY_LOW' ],\n    percent: [ '77.4000015258789063' ] },\n  { name: [ 'WIN_ROUNDS_LOW' ], percent: [ '77' ] }\n  }]\n```\n\nYou should be able to get the basics now how it response, you can read more about this on the [wiki]() page.\n\n\n## License\nMIT License\n\nCopyright (c) 2018 Olle Thunberg\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthunbergolle%2Fweb-api-steam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthunbergolle%2Fweb-api-steam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthunbergolle%2Fweb-api-steam/lists"}