futu-api-js/README.md

Futu Websocket API for Node.js

# futu-api
<a href="https://www.npmjs.com/package/futu-api-js">![npm](https://img.shields.io/npm/v/futu-api-js)</a><br/>
Futu Websocket API for Node.js

## Install
```bash
npm install --save futu-api-js
```

## Usage

Example:
```js
import ftWebsocket from "futu-api-js";

let websocket = new ftWebsocket();
//参数1指定监听地址
//参数2指定Websocket服务端口
//参数3指定是否启用SSL，如果需要启用则需要在FutuOpenD配置相关选项
//参数4指定连接的密钥，否则会连接超时，密钥在在FutuOpenD可配置，UI版本在不指定的情况下会随机指定
websocket.start("127.0.0.1", 33333, false, null);
websocket.onlogin = (ret, msg) => {
  if (ret) {
    const req = {
      c2s: {
        securityList: [{
          market: 1,
          code: "00700",
        }]
      },
    };
  websocket
    .GetSecuritySnapshot(req)
    .then((res) => {
      console.log("res", res)
    })
    .catch((error) => {
      console.log("error:", error);
    });

    //关闭行情连接，连接不再使用之后，要关闭，否则占用不必要资源
    //同时OpenD也限制了最多128条连接
    //也可以一个页面或者一个项目维护一条连接，这里范例请求一次创建一条连接
    websocket.stop();
  } else {
    console.log("error:", msg);
  }
};
```