{"repo":"TTTaevas/osu-api-v2-js","free":true,"listed":false,"github":"https://github.com/TTTaevas/osu-api-v2-js","clone":"git clone https://github.com/TTTaevas/osu-api-v2-js.git","description":"Package to easily access the new api of osu!","language":"TypeScript","stars":34,"topics":["javascript","library","osu","osu-api","osu-api-v2","typescript","api-wrapper"],"license":"Unlicense","category":"api-integrations-sdks","readme_excerpt":"osu-api-v2-js osu-api-v2-js is a JavaScript & TypeScript package that helps you interact with osu!api (v2). The documentation for the latest version of this package can be found at any time on osu-v2.taevas.xyz! How to install and get started Before installing, if using Node.js, check if you're running version 20 or above: Then to install the package, use a command from your package manager: You will want to create your own OAuth application: https://osu.ppy.sh/home/account/edit#oauth To use (import) the package in your project and start interacting with the API, you may do something like that: Configuration options Your api object has many properties (listed as Accessors in the documentation) which you can modify in order to change its behaviour. There are two ways to do that, the first of which is to do it at any point after you've created your object: The other way would be at the same time you're creating your api object, like that: Tokens An access token is required to access the API, and should be valid for 24 hours. When you first create your api object, that token is automatically set before any request is made, so you don't have to worry about that! But how about after those 24 hours? Once an access token has become invalid, the server will no longer respond correctly to requests made with it, instead responding with 401. Thankfully, there are solutions to get and set new access token s in a convenient way, so there is no need to create a new api object every day! - ","default_branch":null,"files":null,"tree":[],"storefront":"/r/TTTaevas","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/TTTaevas/osu-api-v2-js/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}