ausmash-api v1.0.4

Ausmash API

This is a JavaScript service which connects to the Ausmash API which pulls data from Ausmash.

https://ausmash.com.au/ https://api.ausmash.com.au/

Getting access

To access the Ausmash API you will need to be a competitive user on Ausmash. This means you'll need to attend a tournament in Australia or New Zealand and be tagged on the website.

Competitive users can login and go here to generate an API key: https://ausmash.com.au/profile/developer

Using the data

This package uses JavaScript promises to query the Ausmash server for data and return it asynchronously.

Start by creating an AusmashService object and passing your developer key in the constructor like this:

import AusmashService from "ausmash-api";

const service = new AusmashService("YOUARENOTMYKEY");

Examples

Once you have done this you can call the various methods of the service. For example, to load all the games from Ausmash:

service.Pocket.getGames().then(data => {
    console.log(data);
});

This example loads the regions:

service.Regions.getRegions().then(data => {
    setRegions(data);
});

Available data

The following data can be called from service:

• Characters
• Player comparisons
• Elo
• Super Smash Bros. games
• Players
• Tournaments and results
• Rankings
• TrueSkill
• Win rates

Pocket data

The pocket API calls are all smaller and more optimised and were built to support Ausmash Pocket.

https://pocket.ausmash.com.au