{"id":27184261,"url":"https://github.com/hizollo/osu-api","last_synced_at":"2026-02-21T04:32:56.479Z","repository":{"id":56713450,"uuid":"521157908","full_name":"HiZollo/osu-api","owner":"HiZollo","description":"A Node.js library for interacting with osu!api, written in TypeScript.","archived":false,"fork":false,"pushed_at":"2022-12-17T16:14:08.000Z","size":637,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-16T17:06:08.172Z","etag":null,"topics":["osu","osu-api","typescript"],"latest_commit_sha":null,"homepage":"https://hizollo.github.io/osu-api/","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/HiZollo.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":"2022-08-04T06:56:37.000Z","updated_at":"2022-09-09T03:01:59.000Z","dependencies_parsed_at":"2023-01-29T17:31:10.953Z","dependency_job_id":null,"html_url":"https://github.com/HiZollo/osu-api","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/HiZollo/osu-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiZollo%2Fosu-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiZollo%2Fosu-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiZollo%2Fosu-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiZollo%2Fosu-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HiZollo","download_url":"https://codeload.github.com/HiZollo/osu-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiZollo%2Fosu-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264396623,"owners_count":23601541,"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":["osu","osu-api","typescript"],"created_at":"2025-04-09T16:38:32.165Z","updated_at":"2025-07-09T05:04:56.232Z","avatar_url":"https://github.com/HiZollo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @hizollo/osu-api\n[![npm version](https://img.shields.io/npm/v/@hizollo/osu-api.svg?maxAge=3600)](https://www.npmjs.com/package/@hizollo/osu-api)\n[![Downloads](https://img.shields.io/npm/dt/@hizollo/osu-api.svg?maxAge=3600)](https://www.npmjs.com/package/@hizollo/osu-api)\n[![Last Commit](https://img.shields.io/github/last-commit/HiZollo/osu-api)](https://github.com/HiZollo/osu-api)\n[![Code Size](https://img.shields.io/github/languages/code-size/HiZollo/osu-api)](https://github.com/HiZollo/osu-api)\n![License](https://img.shields.io/github/license/HiZollo/osu-api)\n\n## About\nThis library is a node.js wrapper of [osu!api](https://osu.ppy.sh/wiki/en/osu!api) v1.\n\n## Documentation\nYou can look up the documentation [here](https://hizollo.github.io/osu-api).\n\n## Installation\n```\nnpm install @hizollo/osu-api\nyarn add @hizollo/osu-api\n```\n\n## Examples\nImport the package:\n```ts\n// CommonJS\nconst { Client } = require('@hizollo/osu-api')\n\n// ESM\nimport { Client } from '@hizollo/osu-api'\n```\nCreate a client to interact with [osu!api](https://osu.ppy.sh/wiki/en/osu!api):\n```ts\nconst osu = new Client({\n    apiKey: 'your-osu-api-key'\n})\n```\nGet a user's data:\n```ts\nconst user = await osu.users.getUser({ \n    user: 'Cookiezi'\n})\n```\nGet a player's top 5 play:\n```ts\nconst bp = await osu.users.getUserBest({\n    user: '214187',\n    type: UserRequestType.Id,\n    mode: GameMode.Catch,\n    limit: 5\n})\n```\nFetch a player's banner:\n```ts\n// Fetch directly\nconst bannerURL = await osu.users.fetchBanner({\n    id: '7823498'\n})\n\n// ... or if you have the user object\nconst bannerURL = await user.fetchBanner();\n```\n\n## License\nThis package is published under the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhizollo%2Fosu-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhizollo%2Fosu-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhizollo%2Fosu-api/lists"}