{"id":24809736,"url":"https://github.com/tomimelo/steam-explorer","last_synced_at":"2025-03-25T12:21:22.682Z","repository":{"id":62068129,"uuid":"557545019","full_name":"tomimelo/steam-explorer","owner":"tomimelo","description":"An API to search on Steam","archived":false,"fork":false,"pushed_at":"2022-11-08T12:50:07.000Z","size":244,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-15T03:06:56.185Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/steam-explorer","language":"TypeScript","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/tomimelo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-25T22:00:23.000Z","updated_at":"2022-11-08T08:56:52.000Z","dependencies_parsed_at":"2023-01-22T11:31:02.981Z","dependency_job_id":null,"html_url":"https://github.com/tomimelo/steam-explorer","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/tomimelo%2Fsteam-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomimelo%2Fsteam-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomimelo%2Fsteam-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomimelo%2Fsteam-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomimelo","download_url":"https://codeload.github.com/tomimelo/steam-explorer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245458710,"owners_count":20618697,"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":[],"created_at":"2025-01-30T11:15:22.929Z","updated_at":"2025-03-25T12:21:22.642Z","avatar_url":"https://github.com/tomimelo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\n\u003c!-- PROJECT SHIELDS --\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/tomimelo/steam-explorer\"\u003e\n    \u003cimg src=\"https://cdn.freebiesupply.com/images/large/2x/steam-logo-transparent.png\" alt=\"Steam logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eSteam Explorer\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    An API to search on Steam with extended functionalities\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/tomimelo/steam-explorer\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/tomimelo/steam-explorer\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/tomimelo/steam-explorer/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/tomimelo/steam-explorer/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\n      \u003cul\u003e\n        \u003ca href=\"#methods\"\u003eMethods\u003c/a\u003e\n          \u003cul\u003e\n            \u003cli\u003e\u003ca href=\"#new-steamexplorerconfig--steamexplorer-object\"\u003enew SteamExplorer\u003c/a\u003e\u003c/li\u003e\n            \u003cli\u003e\u003ca href=\"#findusersq-options--promisefindresultssteamuser\"\u003efindUsers\u003c/a\u003e\u003c/li\u003e\n            \u003cli\u003e\u003ca href=\"#getsteamidnickname--promisestring\"\u003egetSteamId\u003c/a\u003e\u003c/li\u003e\n          \u003c/ul\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n# About The Project\n\nAPI to search on Steam Community. This is not an official Steam Application and it has no connection with Steam nor its developers\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n## Built With\n\n* [![Node][Node.js]][Node-url]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n# Getting Started\n\nYou need to follow some steps to get this running.\n\n## Prerequisites\n\nYou need to acquire an API key from Steam. You can acquire one [by filling out this form](https://steamcommunity.com/dev/apikey).\n\n## Installation\n\nInstall the package using your package manager of choice.\n   ```sh\n   npm install steam-explorer --save\n   ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n# Usage\n\nYou may then import `SteamExplorer` into your project.\n\n```js\n// ES Modules\nimport { SteamExplorer } from 'steam-explorer';\n\n// CommonJS\nconst { SteamExplorer } = require('steam-explorer');\n```\n\nAfter that, you need to instantiate the class providing the Steam API key in the config and you're ready to use it!\n\n```js\nconst steamExplorer = new SteamExplorer({ apiKey: 'YOUR-API-KEY' });\n\nconst usersResults = await steamExplorer.findUsers('johndoe')\n```\n\n## Methods\n\n### `new SteamExplorer(config) ===\u003e SteamExplorer object`\n\nConstructor to create a new `SteamExplorer` object. You need to provide a `config` object\n\n1.  Constructor Arguments\n\n    -   **config:** {SteamExplorerConfig}. Config object that contains the API key\n\n2.  Example Use\n\n```js\n\nconst config = {\n  apiKey: 'YOUR-API-KEY'\n}\n\nconst steamExplorer = new SteamExplorer(config);\n\n```\n\n### `findUsers(q, options) ===\u003e Promise\u003cFindResults\u003cSteamUser\u003e\u003e`\nFind users in Steam Community\n\n1.  Method Arguments\n\n    -   **q:** {string}. Username to be searched\n    -   **options:** {FindOptions}. Search options. \n    Default values: **page** = 1\n\n2.  Example Use\n\n```js\n\nconst config = {\n  apiKey: 'YOUR-API-KEY'\n}\n\nconst steamExplorer = new SteamExplorer(config);\n\nconst usersResults = await steamExplorer.findUsers('johndoe')\n\nconst moreUsersResults = await steamExplorer.findUsers('johndoe', { page: 2 })\n```\n\n### `getSteamId(nickname) ===\u003e Promise\u003cstring\u003e`\nGet the SteamId of an user from his custom url nickname\n`https://steamcommunity.com/id/{{nickname}}`\n\n1.  Method Arguments\n\n    -   **nickname:** {string}. Custom url nickname to be searched\n\n2.  Example Use\n\n```js\n\nconst config = {\n  apiKey: 'YOUR-API-KEY'\n}\n\nconst steamExplorer = new SteamExplorer(config);\n\n//https://steamcommunity.com/id/johndoe12\nconst steamId = await steamExplorer.getSteamId('johndoe12')\n\n```\n\n----------------------------------------\n\n\u003e ℹ️ More functionalities coming soon... Ideas are welcome. You can request a feature creating a new issue\n\n\u003c!-- CONTRIBUTING --\u003e\n# Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n# License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n# Contact\n\nTomas Melone - [@tomzdotjs](https://twitter.com/tomzdotjs)\n\nProject Link: [https://github.com/tomimelo/steam-explorer](https://github.com/tomimelo/steam-explorer)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/tomimelo/steam-explorer.svg?style=for-the-badge\n[contributors-url]: https://github.com/tomimelo/steam-explorer/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/tomimelo/steam-explorer.svg?style=for-the-badge\n[forks-url]: https://github.com/tomimelo/steam-explorer/network/members\n[stars-shield]: https://img.shields.io/github/stars/tomimelo/steam-explorer.svg?style=for-the-badge\n[stars-url]: https://github.com/tomimelo/steam-explorer/stargazers\n[issues-shield]: https://img.shields.io/github/issues/tomimelo/steam-explorer.svg?style=for-the-badge\n[issues-url]: https://github.com/tomimelo/steam-explorer/issues\n[license-shield]: https://img.shields.io/github/license/tomimelo/steam-explorer.svg?style=for-the-badge\n[license-url]: https://github.com/tomimelo/steam-explorer/blob/master/LICENSE.txt\n[Node.js]: https://img.shields.io/badge/-Node.js-3C873A?style=for-the-badge\u0026logo=Node.js\u0026logoColor=white\n[Node-url]: https://nodejs.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomimelo%2Fsteam-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomimelo%2Fsteam-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomimelo%2Fsteam-explorer/lists"}