#data #st #reserve #opinionated #access #api-key #search

bin+lib freddo

一个用于访问圣路易斯联邦储备银行数据API的有偏见库

1 个不稳定版本

0.1.0 2022年5月21日

#6#reserve

MIT 许可证

32KB
778

弗莱多

这是一个用于访问圣路易斯联邦储备银行数据API的有偏见库。它可能不实现API的所有功能。

要查看在Rust中对API进行一对一实现的库,请参阅 fred-rs.

先决条件

  • 您需要一个可以在此处生成的API密钥 这里
  • 要使用库,将API密钥存储为环境变量 FRED_API_KEY

总体结构

  • client 存储API密钥和与API交互所需的基URL
  • 使用库从构建一个 query 开始
  • 每个 query 属于三种类型之一
    • data 获取实际观测数据
    • search 允许用户通过关键字搜索数据系列
    • info 获取与数据系列相关的元数据
  • 每个查询都有一个 execute 方法来执行请求

lib.rs:

弗莱多是以一种有偏见的方式访问圣路易斯联邦储备银行数据API。

一切从实例化一个 Query 开始。

3 种查询类型

  1. data:从API获取观测数据
  2. search:通过搜索文本搜索数据系列
  3. info:获取与数据系列相关的元数据

query 上调用 execute 方法将通过 client 发送 REST 请求,该客户端存储会话参数和 API 密钥。

依赖项

~4–19MB
~247K SLoC