# ostkit

> A Javascript Client for the OST KIT (kit.ost.com) API

Latest version **0.0.6** (published 2018-05-09) · MIT license · 0 weekly downloads

## Install

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

## 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.0.6 |
| Published | 2018-05-09 |
| First published | 2018-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 26.1 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Stefan Lange-Hegermann |
| Maintainers | stefanlh |
| Keywords | ostkit, ost.com, blockchain, cryptocurrencies, api |

## Links

- npm: https://www.npmjs.com/package/ostkit
- Repository: https://github.com/BlackMac/ostkit.js
- Homepage: http://firmamentbot.com/
- Issues: https://github.com/BlackMac/ostkit.js/issues
- npm.io page: https://npm.io/package/ostkit

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [query-string](https://npm.io/package/query-string.md) ^6.0.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2018-05-09
- 0.0.5 — 2018-05-08
- 0.0.4 — 2018-04-27
- 0.0.3 — 2018-04-27
- 0.0.2 — 2018-04-19
- 0.0.1 — 2018-04-19

## README

# ostkit.js

[![Build Status](https://travis-ci.org/BlackMac/ostkit.js.svg?branch=master)](https://travis-ci.org/BlackMac/ostkit.js)

promise based client for [OST KIT](https://kit.ost.com)

## Installation

Using npm:

```bash
npm install ostkit --save
```

Using yarn:

```bash
yarn add ostkit --save
```

## Usage

Check out the [tutorial for beginners!](https://github.com/BlackMac/ostkit.js/blob/master/TUTORIAL.md)

List users
```js
var Ostkit=require("ostkit")

var ok = new Ostkit("YOUR_API_KEY", "YOUR_API_SECRET");

ok.usersList().then((res) => {
    console.log(res)
});
```

Create a user
```js
var Ostkit=require("ostkit")

var ok = new Ostkit("YOUR_API_KEY", "YOUR_API_SECRET");

ok.usersCreate({name: "Stefan"}).then((res) => {
    console.log(res)
}).catch((e) => {
    console.log("Err", e.response.data.err)
});
```

## Events

You can monitor transactions by using **monitorTransaction(transaction_uuid, callback)** it only gets fired when the transaction status changes and is removed after the first `complete` or `failed` status.

```js
var Ostkit=require("ostkit")

var ok = new Ostkit("YOUR_API_KEY", "YOUR_API_SECRET");

ok.monitorTransaction("transaction-uuid" , function(transaction) {
    if (transaction.status == "complete") {
        console.log("Successful transaction")
    } else if (transaction.status == "failed") {
        console.log("Transaction failed")
    } else {
        console.log("Status: ",transaction.status)
    }
})
```

## Supported Methods

* __usersCreate__`({name})`
* __usersEdit__`({uuid, name})`
* __usersList__`({page_no = 1, filter = "all", order_by = "creation_time", order="desc"})`
* __usersAirdropDrop__`({amount, list_type})`
* __usersAirdropStatus__`({airdrop_uuid})`
* __transactiontypesCreate__`({name, kind, currency_type, currency_value, commission_percent})`
* __transactiontypesEdit__`({client_transaction_id, name, kind, currency_type, currency_value, commission_percent})`
* __transactiontypesList__`()`
* __transactiontypesExecute__`({from_uuid, to_uuid, transaction_kind})`
* __transactiontypesStatus__`({transaction_uuids})`

## FIRMAMENT

ostkit.js is part of my OST KIT⍺ Phase II Project [FIRMAMENT](http://firmamentbot.com) 

I am using [serveo](https://serveo.net/) for development on ostkit.js and [Firmament](https://firmamentbot.com). The author of that awesome service (Trevor) is asking his users for donations to help fund his friends babys liver transplant. If anyone of you can spare some coins [please do so at gofundme.com](https://www.gofundme.com/jun-zacharys-liver-transplant)

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