简介
nodeclient-spectre 是一个 npm 包,用于与 spectre.ai 交互,提供了一些基本的 API 给前端开发者使用。通过该包,前端开发者可以方便快捷地调用 spectre.ai 的接口,实现与 spectre.ai 相关的功能,例如获取历史市场数据、实时数据等。
安装
安装该包非常简单,只需要在终端运行以下命令即可:
npm install nodeclient-spectre
安装成功后,即可将该包导入项目中:
const spectreAPI = require('nodeclient-spectre');
API
该包提供了一些基本的 API,以下是具体说明:
getMarketData(symbol, interval)
获取相应符号和周期的历史市场数据。
参数说明:
- symbol:string,必填,期货、外汇等交易符号,例如 'AUDCAD'、'BTCUSD'。
- interval:string,必填,市场数据的频率,例如 'M1'、'M30'、'H1'、'D1' 等。
返回结果:
- 返回一个 Promise 对象,resolve 后数据为一个数组,其中每个元素为一个包含有各项市场数据的对象。
getRealtimeData(symbol)
获取相应符号的实时市场数据。
参数说明:
- symbol:string,必填,期货、外汇等交易符号,例如 'AUDCAD'、'BTCUSD' 等。
返回结果:
- 返回一个 Promise 对象,resolve 后数据为一个包含有各项实时市场数据的对象。
placeOrder(order)
下订单,将订单信息发送至 spectre.ai。
参数说明:
- order:object,必填,下单信息。该对象必须包含以下字段:
- symbol:string,期货、外汇等交易符号,例如 'AUDCAD'、'BTCUSD' 等。
- direction:string,必填,交易方向,'Call' 或 'Put'。
- expiry:number,必填,到期时间,UNIX 时间戳格式。
- amount:number,必填,交易金额。
- duration:number,选填,持续时间,单位为秒。默认值为 5*60。
- barrier:number,选填,交易障碍,对于高低交易为高/低价格,对于非高低交易为与当前价格的距离。默认值为 0。
返回结果:
- 返回一个 Promise 对象,resolve 后为下单信息。
示例
以下为使用该包的示例,用于获取期货交易数据,进行简单的计算:
-- -------------------- ---- ------- ----- ---------- - ------------------------------ ----- -------- ------ - -- -- ------ - - -- - --- ----- ---------- - ----- ---------------------------------- ------ ------------------------ -- -- ------ ----- ----- ------------ - ----- ------------------------------------- -------------------------- -- ----------------------- ------ ----- --------------- - ---------------------------------- ----- -- ---- - ----------- -- - -- ----- -------- - -------------------------------------- - --------- -- --------- - ---------------- - -- --- ------ ----- ----- ----- - - ------- --------- ---------- ------- ------- ---------- - ------- -- ------ ------- -- -- ----------------------------- - - -------
特别说明
使用 nodeclient-spectre 包仍然需要一个有效的 spectre.ai 帐号,以便获取市场数据和下订单。在使用该包之前,请确保已经在 spectre.ai 注册并开通交易帐户。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5efe9cd9403f2923b035bbd1