{"id":16620518,"url":"https://github.com/spikehd/node-beatsaver","last_synced_at":"2026-04-24T10:04:59.417Z","repository":{"id":105782108,"uuid":"319167044","full_name":"SpikeHD/node-beatsaver","owner":"SpikeHD","description":"An API wrapper for https://beatsaver.com","archived":false,"fork":false,"pushed_at":"2021-03-01T08:19:53.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-18T18:47:13.851Z","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-07T01:02:16.000Z","updated_at":"2021-03-01T08:19:55.000Z","dependencies_parsed_at":"2023-07-01T14:00:51.221Z","dependency_job_id":null,"html_url":"https://github.com/SpikeHD/node-beatsaver","commit_stats":{"total_commits":23,"total_committers":1,"mean_commits":23.0,"dds":0.0,"last_synced_commit":"d6fdfda4010171e2a98f8ad034248f75c30c53eb"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-beatsaver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-beatsaver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-beatsaver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2Fnode-beatsaver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpikeHD","download_url":"https://codeload.github.com/SpikeHD/node-beatsaver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242989015,"owners_count":20217686,"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":"2024-10-12T02:44:31.001Z","updated_at":"2026-04-24T10:04:55.967Z","avatar_url":"https://github.com/SpikeHD.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![https://github.com/SpikeHD/node-beatsaver](https://img.shields.io/github/package-json/v/SpikeHD/node-beatsaver) ![https://github.com/SpikeHD/node-beatsaver](https://img.shields.io/david/SpikeHD/node-beatsaver) ![https://www.npmjs.com/package/node-beatsaver](https://img.shields.io/npm/dw/beatsaver)\n\n# node-beatsaver\nA function-based API wrapper for https://beatsaver.com\n\nhttps://www.npmjs.com/package/beatsaver\n\n# Installation\n\nRun `npm install beatsaver` and `require` it in your project like so:\n```js\nconst bs = require('beatsaver')\n```\n\n# Usage\n\nAll functions are async unless listed otherwise.\n\nJump to:\n* [Functions](#functions)\n* [Examples](#examples)\n* [Contributing](#contributing)\n\n# Functions\n\n`find(query)`\n\nFind maps by searching with a query.\n\n| Parameter | Type |\n| --------- | ---- |\n| query | String |\n\n---\n\n`getbyHash(hash)`\n\nGet maps details by hash string.\n\n| Parameter | Type |\n| --------- | ---- |\n| hash | String |\n\n---\n\n`getByKey(key)`\n\nGet map details by it's key\n\n| Parameter | Type |\n| --------- | ---- |\n| key | String |\n\n---\n\n`getMaps(opts)`\n\nFind maps by sort method.\n\n| Parameter | Type |\n| --------- | ---- |\n| opts | Object |\n\n### Using the `opts` object\n\n| Key | Description | Optional? |\n| --------- | ---- | --------- |\n| sort | Method to sort by | Yes - defaults to 'hot' |\n| page | Page to get | Yes - defaults to 1 |\n\n### Available sort methods\n\n* `uploader` (include `id` param in your options)\n* `hot`\n* `rating`\n* `latest`\n* `downloads`\n* `plays`\n\n---\n\n# Examples\n\n## Finding maps\n\n```js\nconst maps = await bs.find('t+pazolite')\n```\n\n## Getting a map by hash\n\n```js\nconst maps = await bs.getByHash('7f344bbf7ec69b67bd3bc9f03bae39d0b3789120')\n```\n\n## Getting a map by key\n\n```js\nconst maps = await bs.getByKey('105a9')\n```\n\n## Getting maps by sorting method\n\nAvailable sort methods:\n\n* `uploader` (include `id` param in your options)\n* `hot`\n* `rating`\n* `latest`\n* `downloads`\n* `plays`\n\nAlso allows page navigation.\n\n```js\n// Hot maps\nconst byHot = await bs.getMaps({ sort: 'hot' })\n\n// Maps from uploader\nconst byUploader = await bs.getMaps({ sort: 'uploader', id: '5cff0b7698cc5a672c8544e6' })\n\n// Second page of top rated maps\nconst byRating = await bs.getMaps({ sort: 'rating', page: 2 })\n\n// Etc...\n```\n\n# Contributing\nIssues, PRs, etc., are all welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fnode-beatsaver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspikehd%2Fnode-beatsaver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fnode-beatsaver/lists"}