@paroxity/playhiveapi v0.1.2

Installation

The PlayHiveAPI wrapper uses NodeJS and npm. Install it using: npm install playhiveapi

PlayHiveApi.DefaultApi

All URIs are relative to https://api.playhive.com/v0/

getAllTimeLeaderboard

getAllTimeLeaderboard(game)

show all-time leaderboard

Example

import PlayHiveApi from 'play_hive_api';

let apiInstance = new PlayHiveApi.DefaultApi();
let game = "game_example"; // String | Game name

apiInstance.getAllTimeLeaderboard(game, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getCurrentMonthlyLeaderboard

getCurrentMonthlyLeaderboard(game)

show current monthly leaderboard

Example

import PlayHiveApi from 'play_hive_api';

let apiInstance = new PlayHiveApi.DefaultApi();
let game = "game_example"; // String | Game name

apiInstance.getCurrentMonthlyLeaderboard(game, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getMonthlyLeaderboardSingleEntry

getMonthlyLeaderboardSingleEntry(game, player)

show single player entry in current monthly leaderboard

Example

import PlayHiveApi from 'play_hive_api';

let apiInstance = new PlayHiveApi.DefaultApi();
let game = "game_example"; // String | Game name
let player = "player_example"; // String | Player identifier

apiInstance.getMonthlyLeaderboardSingleEntry(game, player, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getPlayerAllTimeStatistics

getPlayerAllTimeStatistics(game, player)

show player all-time statistics

Example

import PlayHiveApi from 'play_hive_api';

let apiInstance = new PlayHiveApi.DefaultApi();
let game = "game_example"; // String | Game name
let player = "player_example"; // String | Player identifier

apiInstance.getPlayerAllTimeStatistics(game, player, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getSpecificMonthlyLeaderboard

getSpecificMonthlyLeaderboard(game, year, month, amount, skip)

show specific monthly leaderboard

Example

import PlayHiveApi from 'play_hive_api';

let apiInstance = new PlayHiveApi.DefaultApi();
let game = "game_example"; // String | Game name
let year = 56; // Number | Year
let month = 56; // Number | Month
let amount = 56; // Number | Amount
let skip = 56; // Number | Skip

apiInstance.getSpecificMonthlyLeaderboard(game, year, month, amount, skip, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getSpecificMonthlyLeaderboardSingleEntry

getSpecificMonthlyLeaderboardSingleEntry(game, player, year, month)

show single player entry in specific monthly leaderboard

Example

import PlayHiveApi from 'play_hive_api';

let apiInstance = new PlayHiveApi.DefaultApi();
let game = "game_example"; // String | Game name
let player = "player_example"; // String | Player identifier
let year = 56; // Number | Year
let month = 56; // Number | Month

apiInstance.getSpecificMonthlyLeaderboardSingleEntry(game, player, year, month, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

This package was automatically generated using Swagger Codegen