spookvooper-api/README.md

34 lines
737 B
Markdown

# SpookVooper API Libraries
Library that is used to easily access the SpookVooper API.
## Usage
We use ES6 modules, because CommonJS makes me want to cry.
**Example Script:**
```js
import svAPI from "spookvooperapi";
let a;
// Get the balance of SpikeViper, and save it to a variable, then console.log it with a prefix
svAPI.eco.getBalance("2a0057e6-356a-4a49-b825-c37796cb7bd9", true).then(value => {
a = value;
console.log(`Spike's Balance: ${a}`);
});
```
The value variable is what the function returns as a result.
It gets passed to the callback function where you can use it.
## Supported Routes
We support all the routes. We even made some.
* Auth
* User
* Group
* Eco
* Premade