# smos_api

> Reverse engineered API for Simple Mining OS

Latest version **0.3.2** (published 2018-02-24) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2018-02-24 |
| First published | 2017-12-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 51.5 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Julien Ferrier |
| Maintainers | ferjul17 |

## Links

- npm: https://www.npmjs.com/package/smos_api
- Repository: https://github.com/ferjul17/smos_api
- Homepage: https://github.com/ferjul17/smos_api#readme
- Issues: http://github.com/ferjul17/smos_api/issues
- npm.io page: https://npm.io/package/smos_api

## Dependencies (4)

- [request](https://npm.io/package/request.md) ^2.83.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^1.1.1
- [tough-cookie](https://npm.io/package/tough-cookie.md) ^2.3.3
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5

## Recent versions

- 0.3.2 (latest) — 2018-02-24
- 0.3.1 — 2018-02-24
- 0.3.0 — 2018-02-23
- 0.2.4 — 2018-02-21
- 0.2.3 — 2018-02-18
- 0.2.2 — 2018-02-18
- 0.2.1 — 2018-02-17
- 0.2.0 — 2018-02-17
- 0.1.0 — 2017-12-12
- 0.0.1 — 2017-12-09

## README

# smos_api
Reverse engineered API for Simple Mining OS

[![Build Status](https://api.travis-ci.org/ferjul17/smos_api.svg?branch=master)](https://travis-ci.org/ferjul17/smos_api)

## Getting Started

To use this library in your project, run:
```bash
npm i smos_api
```

You can use TypeScript:

```typescript
import {API} from "smos_api";

const api = new API("qwe@qwe.com", "qwerty");
api.getListRigs().then((rigs) => {
    console.log(rigs);
});
```

or JavaScript:

```javascript
var smos_api = require("smos_api");
var api = new smos_api.API("qwe@qwe.com", "qwerty");
api.getListRigs().then(function (rigs) {
    console.log(rigs);
});
```

and you get that:

```
[ { id: '5964356',
    gpuCoreFrequencies: [ 1145, 1145, 1145, 1145, 1167, 1145 ],
    gpuMemoryFrequencies: [ 2100, 2100, 2100, 2100, 2100, 2000 ],
    group: 'ether_dwarfpool',
    uptime: '1 week, 14 hours, 6 minutes',
    programStartDate: 2018-02-11T08:06:46.000Z,
    serverTime: 2018-02-18T22:14:07.000Z,
    lastSeenDate: 2018-02-18T22:13:18.000Z,
    totalRestarts: 282,
    kernel: '4.11.0-kfd-compute-rocm-rel-1.6-148',
    ip: '192.168.1.128',
    osVersion: 'RX 1146',
    hashRates: [ 29.01, 29.01, 29.03, 29.04, 28.94, 22.22 ],
    hashRate: 167.25,
    temperatures: [ 59, 60, 59, 59, 60, 61 ],
    fansSpeed: [ 32, 36, 37, 34, 100, 27 ] } ]
```

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