fm- sdk 类型标记

类型脚本 / JavaScript SDK 弹性市场 API (英语).

QQ Alpha 软件——API不稳定

fm-sdk为前1.0并处于积极开发阶段. 任何公众可能 在任何版本中添加、更名或删除,包括以打破方式 编译和运行到今天的代码,并且首先没有折旧期. 下 语义版本 (单位:千美元) 0.x 释放 没有兼容承诺,这些版本就是这样使用的: 处理每个 0.x 撞到可能断裂.

定出一个准确的版本而不是一个范围( N)"@flexemarkets/fm-sdk": "0.2.0", (中文(简体) ), 没有 ^0.2.0,阅读 升级注释 联 合 国 释放您正在移动,并期望您移动时更改代码 .

未建议用于生产.

所需资源

• 节点.js 22+(ES模块)

安装

npm install @flexemarkets/fm-sdk

配置

SDK从这些来源装入证书和终点(最优先的第一):

1. 传递到 Flexemarkets.connect()
2. 文件 ~/.fm/credential 财务报告和审定财务报表 ~/.fm/endpoint (贾瓦语) .properties 格式)
3. 环境变量 FM_API_URL (违约) https://api.flexemarkets.com(中文(简体) )

证书文件

创建 ~/.fm/credential数字 :

account=myaccount
[email protected]
password=secret

或用无记名符:

token=eyJhbGciOiJIUzI1NiJ9...

端点文件

创建 ~/.fm/endpoint数字 :

endpoint=https://api.flexemarkets.com/api/marketplaces/123

SDK 使用情况

import { Flexemarkets } from "@flexemarkets/fm-sdk";

// connect(null, null, ...) falls back to ~/.fm/credential and ~/.fm/endpoint
const fm = await Flexemarkets.connect(null, null, "my-bot");

// REST API
const marketplaceId = fm.endpointMarketplaceId;
const markets = await fm.markets(marketplaceId);
const session = await fm.session(marketplaceId);
const holding = await fm.holding(marketplaceId);

// Submit orders
const order = await fm.submitLimit(marketplaceId, markets[0].id, "BUY", 1, 950);
await fm.submitCancel(marketplaceId, markets[0].id, order.id);

// Live market data. A desk keeps the books and tapes for you: it seeds them
// over REST, applies deltas, and re-seeds after a sequence gap.
const desk = await fm.desk(marketplaceId);
const marketId = markets[0].id;

desk.onBookChange(marketId, (book) => console.log(book.bestPrice("BUY")));
desk.onSessionChange((s) => console.log(s.state));
desk.onHoldingChange((h) => console.log(h.cash));

const one = desk.book(marketId);          // one market
for (const book of desk.books()) {        // every market in the marketplace
  console.log(book.symbol, book.bestPrice("BUY"));
}

desk.close();

示例:计数器

SDK 包含一个勾选例——最能显示订单的活终端 投标/任务、传播和最近的贸易价格.

npx tsx src/ticker.ts -C ~/.fm/credential -E 123

选项 :

输出 :

fm-ticker                                              OPEN

  Symbol     Bid     Ask  Spread   Last trades
  ------  ------  ------  ------   -----------
    AAPL    9.50   10.50    1.00   9.50  10.00
     IBM    4.00    5.00    1.00   4.50

显示会在每个订单簿更新中刷新. 新闻 Ctrl-C 停下来.