pika-api.js
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

pika-api.js

pika-api.js is an NPM package that helps to interact with the public Pika Network API.

Features

  • Fully type-safe
  • Complete type safety in runtime with zod
  • Easy to understand
  • Fully promise-based
  • Built with modern and blazing fast technology
  • Supports both CommonJS and ESModules

Installation

npm install pika-api.js
yarn add pika-api.js
pnpm add pika-api.js

Usage

import Pika from "pika-api.js";
// or
const Pika = require("pika-api.js");

const pika = new Pika.PikaNetwork();
pika.getTotalLeaderboard(Pika.Gamemode.BedWars);
pika.getLeaderboard({
  gamemode: Pika.Gamemode.BedWars,
  leaderboardType: Pika.LeaderboardType.Kills,
  interval: Pika.Interval.Weekly, // Not required, defaults to Interval.AllTime
  mode: Pika.Mode.Solo, // Not required, defaults to Mode.AllModes
  limit: 10, // Not required, defaults to 15
  offset: 15, // Not required, defaults to 0
});
pika.getProfile("mallusrgreat");
pika.getProfileLeaderboard({
  username: "BlakD3mon_",
  gamemode: Pika.Gamemode.BedWars,
  interval: Pika.Interval.Weekly, // Not required, defaults to Interval.AllTime
  mode: Pika.Mode.Solo, // Not required, defaults to Mode.AllModes
  limit: 10, // Not required, defaults to 15
});
pika.getRecap("d1a2a364-148a-4efe-af1e-f40cd7973d4f");

Package Sidebar

Install

npm i pika-api.js

Weekly Downloads

37

Version

1.2.0

License

MIT

Unpacked Size

21.8 kB

Total Files

18

Last publish

Collaborators

  • mallusrgreat