npm 包 fin-ts-client 使用教程

阅读时长 3 分钟读完

介绍

fin-ts-client 是一种用于在 TypeScript 项目中使用 Finnhub API 的客户端库。它提供了一种简单、统一的方式来与 Finnhub API 进行交互,无需手动处理 HTTP 请求和响应,从而减少了代码的复杂度。

本文将从以下几个方面介绍 fin-ts-client 的使用方法:

  1. 安装
  2. 初始化
  3. 请求数据
  4. 示例代码

安装

使用 npm 安装 fin-ts-client:

初始化

为了使用 fin-ts-client,请按以下步骤进行初始化:

  1. 引入 fin-ts-client:
  1. 创建 FinTsClient 实例:

在初始化阶段,您需要提供 Finnhub API 的 API 令牌,通常可以在 官网 上获取。您还可以提供其他选项,例如 base URL、默认超时时间等等。有关更多信息,请参见官方文档。

请求数据

fin-ts-client 提供了多种方法来请求 Finnhub API 提供的不同数据点。以下是其中的一些方法。

获取交易数据

getTrades 方法允许您获取任何股票的交易数据。可以通过提供股票符号、时间范围等参数来筛选结果。

获取市场新闻

getNews 方法允许您获取特定市场或一般区域的新闻。此方法还允许您过滤掉 minId 和 maxId 之间的新闻,以减少结果的数量。

示例代码

以下是一个使用 fin-ts-client 进行股票交易数据查询的示例代码:

-- -------------------- ---- -------
------ ----------- ---- ----------------

----- -------- ----------- -
  ----- ------ - --- -------------
    --------- -----------------
  ---

  ----- -------- - ----- ------------------
    ------- -------
    ----- -------------- ---------------------------- - ------
    --- -------------- ---------------------------- - ------
  ---

  ---------------------------
-

------------

此示例会输出 AAPL 股票在 2022 年 1 月 1 日到 1 月 6 日期间的交易数据。在实际使用中,您可以根据自己的需求进行修改。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005573181e8991b448d4241

纠错
反馈