{"id":16620545,"url":"https://github.com/spikehd/node-scoresaber","last_synced_at":"2025-10-03T19:57:37.210Z","repository":{"id":45387908,"uuid":"294487843","full_name":"SpikeHD/node-scoresaber","owner":"SpikeHD","description":"Scoresaber API wrapper","archived":false,"fork":false,"pushed_at":"2021-03-01T09:21:53.000Z","size":149,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-03T19:57:37.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpikeHD.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":"2020-09-10T18:15:54.000Z","updated_at":"2021-03-01T09:21:55.000Z","dependencies_parsed_at":"2022-07-13T21:44:46.838Z","dependency_job_id":null,"html_url":"https://github.com/SpikeHD/node-scoresaber","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SpikeHD/node-scoresaber","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-scoresaber","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-scoresaber/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-scoresaber/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-scoresaber/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpikeHD","download_url":"https://codeload.github.com/SpikeHD/node-scoresaber/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-scoresaber/sbom","scorecard":{"id":132979,"data":{"date":"2025-08-04","repo":{"name":"github.com/SpikeHD/node-scoresaber","commit":"30179f2524eabcc3e10281494205dfecbe8bf4cc"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T05:39:49.969Z","repository_id":45387908,"created_at":"2025-08-16T05:39:49.969Z","updated_at":"2025-08-16T05:39:49.969Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278219772,"owners_count":25950350,"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","status":"online","status_checked_at":"2025-10-03T02:00:06.070Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2024-10-12T02:44:32.546Z","updated_at":"2025-10-03T19:57:37.188Z","avatar_url":"https://github.com/SpikeHD.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![https://github.com/SpikeHD/node-scoresaber](https://img.shields.io/github/package-json/v/SpikeHD/node-scoresaber) ![https://github.com/SpikeHD/node-scoresaber](https://img.shields.io/david/SpikeHD/node-scoresaber) ![https://www.npmjs.com/package/node-scoresaber](https://img.shields.io/npm/dw/node-scoresaber)\n\n## node-scoresaber\n\nA NodeJS API wrapper for https://new.scoresaber.com/\n\nhttps://www.npmjs.com/package/node-scoresaber\n\n# Description\n\n`node-scoresaber` is an asynchronous function-based API wrapper for [scoresaber.com](https://new.scoresaber.com/) written in Javascript using `axios`. It supports viewing player stats, ranked request lists and request details, player searching, ~~and song leaderboards and details~~. \n\n# Installation\n\nSimply run `npm install node-scoresaber` and require it in your program:\n```js\nconst saber = require('node-scoresaber')\n```\n\n# Usage\n\nEverything is based off of functions. Internally, these functions actually return instances of classes, which used to be how you would interact with this module until v2.0.0, but now it should be much cleaner and easier to use.\n\n\\* *All functions are asynchronous unless otherwise mentioned*\n\nJump to:\n* [Functions](#functions)\n  * [Players](#players)\n      * `searchPlayers(name)`\n      * `getPlayer(id)`\n  * [Requests](#requests)\n      * `getRequest(id)`\n      * `getTopRequests()`\n      * `getAllRequests()`\n* [Examples](#examples)\n* [Contributing](#contributing)\n\n# Functions\n\n## Players\n\n`getPlayer(id)`\n\n| Parameter | Type |\n| --------- | ---- |\n| id | String or Number. Usually Steam ID or Oculus ID |\n\n### Returns\n\nReturn value: `Object`\n\n| Property | Description |\n| -------- | ----------- |\n| name | Username of the player |\n| avatar_url | URL that points to player avatar |\n| rank | Current global rank |\n| countryRank | Current rank in their respective country |\n| country | Short-form version of player's respective country |\n| pp | Total PP |\n| role | Player role (eg.\"Supporter\")\n| badges | Array of badges the player has, and their image links |\n| isBanned | Boolean - whether player is banned |\n| isInactive | Boolean - whether player is inactive |\n| totalScore | Total score earned |\n| totalRankedScore | Total score for ranked songs only |\n| averageRankedAccuracy | Average ranked accuracy |\n| playCount | Total amount of plays |\n| rankedPlayCount | Total amount of ranked plays |\n\n---\n\n`searchPlayers(name)`\n\n| Parameter | Type |\n| --------- | ---- |\n| name | String |\n\n### Returns\n\nReturn value: `Array` of `Objects`\n\nEach object contains:\n\n| Property | Description |\n| -------- | ----------- |\n| playerId | ID of player |\n| playerName | Name of player |\n| rank | Current global rank |\n| pp | Current total PP |\n| avatar | URL that points to player avatar |\n| country | Short-form version of player's respective country |\n| history | Array of ranking history |\n| difference | Rank difference from the last 2 weeks |\n| get | Async function, shorthand for `getPlayer()` (does not require ID param) |\n\n## Requests\n\n`getRequest(id)`\n\n| Parameter | Type |\n| --------- | ---- |\n| id | String or Number |\n\n### Returns\n\nReturn value: `Object`\n\n| Property | Description |\n| -------- | ----------- |\n| default_url | Root scoresaber URL |\n| request | Request ID |\n| songID | Song ID |\n| requestType | Number, not sure what it means |\n| description | Request description |\n| approved | Boolean - whether request has been approved |\n| id | Some other ID |\n| difficulty | Number. Correlation: `Easy -\u003e 1`, `Normal -\u003e 3`, `Hard -\u003e 5`, `Expert -\u003e 7`, `Expert+ -\u003e 9`, etc. |\n| rankUpvotes | Rank upvotes |\n| rankDownvotes | Rank downvotes |\n| qatUpvotes | QAT Upvotes |\n| qatDownvotes | QAT Downvotes |\n| rankComments | Array of rank comments |\n| qatComments | Array of QAT comments |\n| Difficulties | Array of objects containing the requests other difficulties |\n\n---\n\n`getAllRequests()` and `getTopRequests()`\n\n- No Parameters -\n \n### Returns\n \nReturn value: `Array` of `Objects`\n \nEach object contains:\n \n| Parameter | Description |\n| --------- | ----------- |\n| request | ID of the request |\n| songId | Song ID |\n| weight | Request weight |\n| name | Song name |\n| levelAuthorName | Name of the author |\n| id | Some other ID |\n| created_at | Timestamp of request creation |\n| rankVotes | Object with keys: `upvotes`, `downvotes`, `myVote` |\n| qatVotes | Object with keys: `upvotes`, `downvotes`, `myVote` |\n| difficulties | Number of difficulties |\n| get | Async function, shorthand for `getRequest()` (does not require ID param) |\n\n# Examples\n\n## Searching for and getting details of a player\n```js\nconst myPlayer = await saber.searchPlayers('spikehd')\n\nif (myPlayer[0]) {\n  console.log(await myPlayer[0].get())\n}\n```\n\n## Getting a player by ID\n```js\nconst myPlayer = await saber.getPlayer('76561198106696130')\nconsole.log(myPlayer)\n```\n\n## Getting a top request\n```js\nconst topRequests = await saber.getTopRequests()\n\nif (topRequests[0]) {\n  console.log(await topRequests[0].get())\n}\n```\n\n## Getting a request by ID\n```js\nconst request = await saber.getRequest('1234')\nconsole.log(request)\n```\n\n# Contributing\nIssues, PRs, etc., are all welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fnode-scoresaber","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspikehd%2Fnode-scoresaber","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fnode-scoresaber/lists"}