{"id":25920080,"url":"https://github.com/lovethebomb/quake-champions-api","last_synced_at":"2025-03-03T15:18:46.715Z","repository":{"id":149202114,"uuid":"137272250","full_name":"lovethebomb/quake-champions-api","owner":"lovethebomb","description":"🚀Unofficial Quake Champions API JavaScript client","archived":false,"fork":false,"pushed_at":"2024-08-19T08:11:27.000Z","size":219,"stargazers_count":6,"open_issues_count":5,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-11T13:37:05.449Z","etag":null,"topics":["api","client","javascript","quake","quake-champions","stats"],"latest_commit_sha":null,"homepage":"","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/lovethebomb.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-13T21:16:52.000Z","updated_at":"2024-08-19T08:11:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"eb5e5971-1abe-4f54-8d51-b53896c03e01","html_url":"https://github.com/lovethebomb/quake-champions-api","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lovethebomb%2Fquake-champions-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lovethebomb%2Fquake-champions-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lovethebomb%2Fquake-champions-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lovethebomb%2Fquake-champions-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lovethebomb","download_url":"https://codeload.github.com/lovethebomb/quake-champions-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240142962,"owners_count":19754652,"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","client","javascript","quake","quake-champions","stats"],"created_at":"2025-03-03T15:18:46.172Z","updated_at":"2025-03-03T15:18:46.704Z","avatar_url":"https://github.com/lovethebomb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quake-champions-api\n\n\u003e [!CAUTION]\n\u003e This package is not maintained nor updated\n\u003e Official Quake Stats are currently slightly broken (no matches)\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/lovethebomb/quake-champions-api.svg)](https://greenkeeper.io/)\n\nThis is an unofficial JS client for the [Quake Champions](quake-website) API, provided from [stats.quake.com][quake-stats] website.\n\nThis project shouldn't be used in production as no official developer access has been provided to the Quake Champions API, thus it mainly map the calls seen from the [stats.quake.com][quake-stats] page, and the current API calls might not work in the future.\n\n## Installation\n\n```bash\nnpm i\n```\n\n## Usage\n\n### Quick example\n\n```javascript\nconst QuakeChampionsClient = require('quake-champions-api');\n\nconst client = new QuakeChampionsClient();\n\nasync function getData() {\n    // Fetch player\n    const player = await client.player.get('lovethebomb');\n\n    console.debug('Player data', player)\n    console.debug('Duel SR', player.playerRatings.duel.rating)\n}\n```\n\n## Documentation\n\n- [Player](#player)\n- [Match](#match)\n- [GamesSummary](#gamessummary)\n- [Leaderboard](#leaderboard)\n- [Rankings](#rankings)\n\n### Player\n\n#### get(playername)\n\nRetrieve a player data for a given `playername`.\n\nReturns JSON from the API.\n\n```javascript\nconst client = new QuakeChampionsClient();\n\nasync function getPlayer() {\n    const player = await client.player.get('my-playername');\n}\n```\n\n### Match\n\n#### get(matchId, playername)\n\nRetrieve a match data for a given `matchId`.\n\nAllows an optional `playername` argument, which adds more information to the response.\n\nReturns JSON from the API.\n\n```javascript\nconst client = new QuakeChampionsClient();\n\nasync function getMatch() {\n    const match = await client.match.get('match-id-1234abc');\n}\n\nasync function getMatchWithPlayerSummary() {\n    const match = await client.match.get('match-id-1234abc', 'my-playername');\n}\n```\n\n### GamesSummary\n\n#### get(playername)\n\nRetrieve a GamesSummary data for a given `playername`.\n\nReturns JSON from the API.\n\n```javascript\nconst client = new QuakeChampionsClient();\n\nasync function getGamesSummary() {\n    const gamesSummary = await client.gamesSummary.get('my-playername');\n}\n```\n\n### Leaderboard\n\n#### get(board, season, from)\n\nRetrieve a Leaderboard data for a given `board` type.\n\nBoard can be `duel` or `tdm`.\n\nAllows an optional `season` argument, which defaults to `current`.\n\nAllows an optional `from` argument, for pagination, which defaults to `0`.\n\nReturns JSON from the API.\n\n```javascript\nconst client = new QuakeChampionsClient();\n\nasync function getDuelLeaderboard() {\n    const leaderboard = await client.leaderboard.get('duel');\n}\n```\n\n### Rankings\n\n#### ranking(rating)\n\nReturns a ranking for a given `rating`, as a string like `GOLD_1`.\n\n```javascript\nconst client = new QuakeChampionsClient();\n\nasync function getPlayer() {\n    const player = await client.player.get('my-playername');\n    const ranking = client.rankings.ranking(player.playerRatings.duel.rating);\n}\n```\n\n## Testing\n\n```bash\nnpm run test\n```\n\n## License\n\nMIT\n\nTODO Trademarks QUAKE™, id Software™, Bethesda™, Bethesda Softworks™, ZeniMax™\n\n[quake-stats]: https://stats.quake.com\n[quake-website]: https://quake.bethesda.net","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flovethebomb%2Fquake-champions-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flovethebomb%2Fquake-champions-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flovethebomb%2Fquake-champions-api/lists"}