futu-api

library10.7.6708jsnpmunverified

富途证券官方 Websocket API 的 Node.js 封装，版本 10.7.6708（2024年）。提供行情订阅、交易下单、账户查询等接口，支持港股、美股、A股市场。与利弗莫尔证券或其他第三方 API 不同，这是富途官方维护的包，更新频繁（每月多个版本），使用 Protobuf 协议，需搭配 FutuOpenD 桌面端使用。自 2021 年 4 月起由富途官方维护，版本号自成体系（非语义化）。

finance

npm install futu-api

package ↗

INSTALL

IMPORT

SIG · FUTU-API

futu-api

financejavascriptv10.7.6708

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

FutuAPI

✓ import { FutuAPI } from 'futu-api'

✗ const futuApi = require('futu-api')

包提供 CommonJS 和 ESM 双格式，Node.js 推荐使用 import 或 require。

FutuAPI

✓ import FutuAPI from 'futu-api'

默认导出与命名导出均为 FutuAPI，写法等价。

FutuAPI

✓ const { FutuAPI } = require('futu-api')

CommonJS 中命名导出也可使用。

初始化 FutuAPI 客户端，连接本地 FutuOpenD 进程，订阅股票行情并获取基本信息。

import { FutuAPI } from 'futu-api'; const api = new FutuAPI({ host: process.env.FUTU_HOST ?? '127.0.0.1', port: parseInt(process.env.FUTU_PORT ?? '11111'), password: process.env.FUTU_PASSWORD ?? '', }); async function main() { await api.connect(); // 订阅行情 const code = 'HK.00700'; const subType = 1; // 1: 逐笔 await api.subscribe([code], [subType]); console.log(`已订阅 ${code}`); // 获取基本信息 const stockInfo = await api.getStockBasicInfo([code]); console.log(stockInfo); api.close(); } main().catch(console.error);

Debug

Known issues

breaking版本号规则与 npm 语义化版本不同，10.7.6708 不能视为 major.minor.patch

fix

在 package.json 中直接锁定精确版本，不要使用 ^ 或 ~ 前缀。

affects: >1.0

deprecated旧版 require('futu-api') 默认导出行为可能不同，建议检查文档

fix

升级到 v10 后改用 import { FutuAPI } from 'futu-api' 或 const { FutuAPI } = require('futu-api')。

affects: <10.0

gotcha必须本地运行 FutuOpenD 进程，且版本需与 api 版本匹配

fix

从富途官网下载最新版 FutuOpenD 并保持运行。

affects: >=1.0

gotcha行情订阅有频率限制，超过阈值会被断开连接

fix

控制订阅频率，建议使用队列机制，参考官方示例。

affects: >=1.0

Errors

Common errors & fixes

Error: connect ECONNREFUSED 127.0.0.1:11111

FutuOpenD 未运行或端口错误

fix

启动 FutuOpenD 并检查 host/port 配置。

TypeError: FutuAPI is not a constructor

使用了错误的导入方式

fix

使用 const { FutuAPI } = require('futu-api') 或 import { FutuAPI } from 'futu-api'。

Error: Auth failed, check password

密码错误或未设置

fix

确保传入正确的 login password（富途交易密码）。

Upgrade

Version history

10.7.6708latest on npm

Audit

Dependencies

protobufjsrequired用于解析 Protobuf 协议消息

Agent activity

30 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

packagefutu-api ↗