freddo

Crates.iofreddo
lib.rsfreddo
version0.1.0
sourcesrc
created_at2022-05-21 14:29:28.165225
updated_at2022-05-21 14:29:28.165225
descriptionAn opinionated library to access the Federal Reserve of St Louis data API
homepage
repositoryhttps://gitlab.com/bzai-public/rust_fred
max_upload_size
id590738
size56,241
(dexter-san)

documentation

README

Freddo

This is an opinionated library for accessing the Federal Reserve of St Louis data API. It may not implement all the functionalities of the API.

For a like-for-like implementation of the API in Rust, see fred-rs.

Pre-requisites

  • You will need an API key that can be generated here
  • To use the library, store the API key as the environment variable FRED_API_KEY

General structure

  • A client stores the API key and the base URLs that are needed to interact with the API
  • The use of the library starts with the construction of a query
  • Each query belongs to one of the three types:
    • data which obtains the actual observations
    • search which allows the user to search for data series using key words
    • info which obtains the metadata related to a data series
  • Each query has an execute method to carry out the request
Commit count: 12

cargo fmt