Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

okcoin-china

xhad8.3kMIT0.0.7

Nodejs API wrapper for OKCoin China

OKCoin, China, api, exchange, bitcoin

readme

OKCoin China API Wrapper

A node.js wrapper for the REST APIs exposed by bitcoin exchange OKCoin. You will need to have a registered account with OKCoin 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.

forked from naddison36

A node.js wrapper for the REST APIs exposed by bitcoin exchange OKCoin. You will need to have a registered account with OKCoin and generated API keys to access the private methods.

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

Install

npm install okcoin-china

var OKCoin = require('okcoin-china');

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

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

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

// get trades defaulting to BTCCNY
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 0.01 BTC at price 4000 CNY
privateClient.addTrade(console.log, 'btc_cny', 'buy', '0.01', '4000');