# okex-rest

> Nodejs API wrapper for OKEX exchange

Latest version **0.0.1** (published 2018-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install okex-rest
pnpm add okex-rest
yarn add okex-rest
bun add okex-rest
```

## 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.1 |
| Published | 2018-02-12 |
| First published | 2018-02-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Ivan Kocheshev |
| Maintainers | devmanio |
| Keywords | okex, api, exchange, bitcoin |

## Links

- npm: https://www.npmjs.com/package/okex-rest
- Repository: https://github.com/devmanio/okex-rest
- Homepage: https://github.com/devmanio/okex-rest#readme
- Issues: https://github.com/devmanio/okex-rest/issues
- npm.io page: https://npm.io/package/okex-rest

## Dependencies (5)

- [md5](https://npm.io/package/md5.md) 2.x
- [crypto](https://npm.io/package/crypto.md) ~0.0.3
- [verror](https://npm.io/package/verror.md) ~1.6.0
- [request](https://npm.io/package/request.md) ~2.67.0
- [underscore](https://npm.io/package/underscore.md) ~1.8.3

## Recent versions

- 0.0.1 (latest) — 2018-02-12

## README

# OKEX  API Wrapper


A node.js wrapper for the [REST APIs](hhttps://www.okex.com/rest_api.html) exposed by bitcoin exchange [OKEX](https://www.okex.com).
You will need to have a registered account with [OKEX](https://www.okex.com) and generated API keys to access the private methods.

Please contact support@okcoin.com if you are having trouble opening an account or generating an API key.

This module is forked from [okcoin-china](https://github.com/xhad/okcoin-china).

### Install

`npm install okex-rest`

```js
var OKEX = require('okex-rest');

// Test public data APIs
var publicClient = new OKEX();

// get iota_btc ticker
publicClient.getTicker(console.log, 'iota_btc');

// get iota_btc order book
publicClient.getDepth(console.log, 'iota_btc');

// get trades defaulting to iota_btc
publicClient.getTrades(console.log);

// replace the parameters with your API key and secret
var privateClient = new OKCoin('your-api-key', 'your-api-secret');

privateClient.getUserInfo(console.log);

// buy limit order for 1 IOTA at price 00021054 BTC
privateClient.addTrade(console.log, 'iota_btc', 'buy', '1', '00021054');

```

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