# gapple

> An api wrapper for api.gapple.pw

Latest version **1.0.5** (published 2022-02-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install gapple
pnpm add gapple
yarn add gapple
bun add gapple
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2022-02-03 |
| First published | 2022-02-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | djoerkie |
| Maintainers | djoerkie |
| Keywords | minecraft, api, wrapper |

## Links

- npm: https://www.npmjs.com/package/gapple
- Repository: https://github.com/djoerkie/gapple
- Homepage: https://github.com/djoerkie/gapple#readme
- Issues: https://github.com/djoerkie/gapple/issues
- npm.io page: https://npm.io/package/gapple

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.25.0
- [@types/es6-promise](https://npm.io/package/@types/es6-promise.md) ^3.3.0

## Recent versions

- 1.0.5 (latest) — 2022-02-03
- 1.0.4 — 2022-02-03
- 1.0.3 — 2022-02-03
- 1.0.2 — 2022-02-03
- 1.0.0 — 2022-02-03

## README

# Gapple API
A nodejs api wrapper for https://api.gapple.pw

## Installation

```bash
npm i gapple
```

## Usage

```javascript
const GappleApi = require('gapple');

/*
    Get status of a minecraft profile
    requires uuid
*/
GappleApi.checkStatus('f30de451a4db4d99aa71e4dea1941080').then(resp => {
    console.log(resp)
});


/*
    Check if uuid is pseudo hard-deleted
    requires uuid
*/
GappleApi.checkPHD('1449546f71de47ebbef8809cd3afd6c6').then(resp => {
    console.log(resp)
});


/*
    Check if a username will be reclaimed
    requires username to check and current account username
    !!!! This example will not work anymore because 
*/
GappleApi.checkReclaim('username_to_check', 'current_account_name').then(resp => {
    console.log(resp)
});


/*
    Check if a username is blocked
    requires username
*/
GappleApi.checkBlocked('animate').then(resp => {
    console.log(resp)
});


/*
    Check user profile
    requires uuid
*/
GappleApi.getUserProfile('f30de451a4db4d99aa71e4dea1941080').then(resp => {
    console.log(resp)
});


/* 
    Check user profile by username
    requires username
*/
GappleApi.getUserProfileByUsername('TheFancyBear').then(resp => {
    console.log(resp)
});


/*
    Get previous usernames
    requires uuid
*/
GappleApi.getUserNames('f30de451a4db4d99aa71e4dea1941080').then(resp => {
    console.log(resp)
});
```

---
_Source: https://npm.io/package/gapple · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
