简述
在前端开发中,如果需要进行数字货币交易的功能开发,常常会用到交易所的API。okcoin.com是国内知名的数字货币交易所之一,提供了完整的API接口供开发者使用,包括行情接口、交易接口、账户接口等,极大的便利了开发者的开发工作。
为了方便的使用okcoin.com的API接口,我们可以使用别人已经封装好的npm包,这里就介绍一下如何使用npm包okcoin.com。
安装
在终端(命令行)中输入以下命令,即可安装okcoin.com npm包。
npm install okcoin.com --save
参数说明
使用okcoin.com npm包时,我们首先需要了解一些接口中常用的参数,下面是一些常用的参数介绍。
参数 | 说明 |
---|---|
apiKey | API Key |
secretKey | Secret Key |
passphrase | Passphrase |
url | API请求地址 |
API接口列表
okcoin.com提供了众多的API接口供开发者使用,这里将介绍一部分常用的接口。
行情接口
这里介绍两个行情接口,分别是获取k线数据和获取交易对信息。
获取k线数据
const okcoin = require('okcoin.com'); const client = new okcoin('', '', '', okcoin.REST_URL); client.kline('btc_usd', '1hour', '2015-01-01', '2015-02-01', (error, data) => { if (error) console.error(error); else console.log(data); });
- 第一个参数:交易对,取值例如btc_usd,eth_btc等模式;
- 第二个参数:时间段,取值例如1min,3min,5min等模式;
- 第三个参数:开始时间,格式yyyy-MM-dd HH:mm:ss;
- 第四个参数:结束时间,格式yyyy-MM-dd HH:mm:ss。
获取交易对信息
const okcoin = require('okcoin.com'); const client = new okcoin('', '', '', okcoin.REST_URL); client.symbols((error, data) => { if (error) console.error(error); else console.log(data); });
交易接口
这里介绍下单和撤单的接口。
下单
const okcoin = require('okcoin.com'); const client = new okcoin(apiKey, secretKey, passphrase, okcoin.FUTURES_URL); client.futures_trade('btc_usd', 'quarter', 'buy', 10, 2000, '', '', (error, data) => { if (error) console.error(error); else console.log(data); });
- 第一个参数:交易对,取值例如btc_usd,eth_btc等模式;
- 第二个参数:合约类型,取值例如this_week,next_week,quarter等模式;
- 第三个参数:买卖类型,取值为buy或者sell;
- 第四个参数:下单数量,必填;
- 第五个参数:下单价格,必填。
撤单
const okcoin = require('okcoin.com'); const client = new okcoin(apiKey, secretKey, passphrase, okcoin.FUTURES_URL); client.futures_cancel('btc_usd', 'quarter', '1234567890', (error, data) => { if (error) console.error(error); else console.log(data); });
- 第一个参数:交易对,取值例如btc_usd,eth_btc等模式;
- 第二个参数:合约类型,取值例如this_week,next_week,quarter等模式;
- 第三个参数:订单ID,必填。
账户接口
这里介绍获取账户信息的接口。
获取账户信息
const okcoin = require('okcoin.com'); const client = new okcoin(apiKey, secretKey, passphrase, okcoin.REST_URL); client.accounts((error, data) => { if (error) console.error(error); else console.log(data); });
示例代码
下面是一个简单的实例代码,实现了获取最新交易信息、获取账户信息、下单和撤单的功能。
-- -------------------- ---- ------- ----- ------ - ---------------------- ----- ------ - ----------------- ----- --------- - -------------------- ----- ---------- - -------------------- ----- ------ - --- -------------- ---------- ----------- -------------------- ---------------- -------- ------ ------------------------ ------- ----- -- - -- ------- --------------------- ---- ------------------ --- ---------------- ------ ------ ----------------------- ----- -- - -- ------- --------------------- ---- ------------------ --- ---------------- -- ------ ------------------------------- ---------- ------ -- ----- --- --- ------- ----- -- - -- ------- --------------------- ---- ------------------ --- ---------------- -- ------ -------------------------------- ---------- ------------- ------- ----- -- - -- ------- --------------------- ---- ------------------ ---
总结
通过使用npm包okcoin.com,我们可以方便的使用okcoin.com提供的API接口,实现数字货币交易等功能。这里介绍的只是一部分常用的API接口,更多的API接口详细信息可以查阅okcoin.com官方文档。希望本文能够对前端开发者有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066fac3d1de16d83a671f0