# fudzycoin-api

> Fudzy Coin API

Latest version **1.0.7** (published 2022-02-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install fudzycoin-api
pnpm add fudzycoin-api
yarn add fudzycoin-api
bun add fudzycoin-api
```

## 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.7 |
| Published | 2022-02-23 |
| First published | 2022-02-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | sexme |

## Links

- npm: https://www.npmjs.com/package/fudzycoin-api
- npm.io page: https://npm.io/package/fudzycoin-api

## Recent versions

- 1.0.7 (latest) — 2022-02-23
- 1.0.6 — 2022-02-23
- 1.0.5 — 2022-02-13
- 1.0.4 — 2022-02-13
- 1.0.3 — 2022-02-13
- 1.0.2 — 2022-02-13
- 1.0.1 — 2022-02-13
- 1.0.0 — 2022-02-13

## README

# FudzyCoin API

[![npm package](https://nodei.co/npm/fudzycoin-api.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/fudzycoin-api/)  
![author](https://img.shields.io/badge/author-sexme-brightgreen)
![version](https://img.shields.io/npm/v/fudzycoin-api.svg?style=flat-square)
![license](https://shields.io/npm/l/fudzycoin-api)
![rating](https://img.shields.io/badge/rating-★★★★★-brightgreen)  
**Библиотека для FudzyCoin API**

## Установка

Модуль написан на [Node.js](https://nodejs.org/en/)
Устанавливается с помощью [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)  

```
$ npm install fudzycoin-api
```

## **Обновление v1.0.7**
##### Обновлён README.MD
##### В связи с тем, что в официальном API FudzyCoin был удалён метод getGlobalWins, на смену пришли два новых метода
[getGlobalDailyWins](https://www.npmjs.com/package/fudzycoin-api#getGlobalDailyWins) -- Получить топ по победам в играх за день   
[getGlobalWeeklyWins](https://www.npmjs.com/package/fudzycoin-api#getGlobalWeeklyWins) -- Получить топ по победам в играх за неделю   


## Использование  


```js
const FudzyCoin = require('fudzycoin-api');
const api = new FudzyCoin('ваш token');
```

 token - токен авторизации
 
## Методы

#### Список методов API  
[getUser](https://www.npmjs.com/package/fudzycoin-api/getUser) -- Получить информацию о пользователе   
[getTransfers](https://www.npmjs.com/package/fudzycoin-api#getTransfers) -- Получить информацию о переводах   
[getGlobalDailyWins](https://www.npmjs.com/package/fudzycoin-api#getGlobalDailyWins) -- Получить топ по победам в играх за день   
[getGlobalWeeklyWins](https://www.npmjs.com/package/fudzycoin-api#getGlobalWeeklyWins) -- Получить топ по победам в играх за неделю   
[getGlobalRefs](https://www.npmjs.com/package/fudzycoin-api#getGlobalRefs) -- Получить топ по количеству рефералов   
[getGlobalCoins](https://www.npmjs.com/package/fudzycoin-api/getGlobalCoins) -- Получить топ по коинам   
[sendCoins](https://www.npmjs.com/package/fudzycoin-api/getGlobalCoins) -- Перевод коинов   
[findUser](https://www.npmjs.com/package/fudzycoin-api/findUser) -- Поиск пользователя   
# Примеры
### getUser

```js
const result = await api.getUser(user_id);
console.log(result);
```
user_id - ID аккаунта VK


### getTransfers

```js
const result = await api.getTransfers();
console.log(result);
```

Параметры не предусмотрены

### getGlobalWins

```js
const result = await api.getGlobalWins();
console.log(result);
```
Параметры не предусмотрены

### getGlobalRefs

```js
const result = await api.getGlobalRefs();
console.log(result);
```
Параметры не предусмотрены

### getGlobalDailyCoins

```js
const result = await api.getGlobalDailyCoins();
console.log(result);
```
Параметры не предусмотрены

### getGlobalWeeklyCoins

```js
const result = await api.getGlobalWeeklyCoins();
console.log(result);
```
Параметры не предусмотрены

### sendCoins
```js
const result = await api.sendCoins(to_id, amount);
console.log(result);
```
to_id - ID пользователя, кому хотим перевести
amount - сумма перевода

### findUser
```js
const result = await api.findUser(query);
console.log(result);
```
query - ключевое слово, по которому нужно найти пользователя

---
### По всем вопросам обращаться к [разработчику](https://vk.com/domen.null)
### Официальное приложение [FudzyCoin](https://vk.com/fudzy_coin)

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