Module: FREDAPI::Client::Series

Includes:
Categories, Observations, Release, Search, Tags, Updates, VintageDates
Included in:
FREDAPI::Client
Defined in:
lib/fredapi/client/series.rb,
lib/fredapi/client/series/tags.rb,
lib/fredapi/client/series/search.rb,
lib/fredapi/client/series/release.rb,
lib/fredapi/client/series/updates.rb,
lib/fredapi/client/series/categories.rb,
lib/fredapi/client/series/search/tags.rb,
lib/fredapi/client/series/observations.rb,
lib/fredapi/client/series/vintage_dates.rb,
lib/fredapi/client/series/search/related_tags.rb

Overview

Series module for fred/series endpoint

Defined Under Namespace

Modules: Categories, Observations, Release, Search, Tags, Updates, VintageDates

Instance Method Summary collapse

Methods included from VintageDates

#series_vintage_dates

Methods included from Updates

#series_updates

Methods included from Tags

#series_tags

Methods included from Search

#series_search

Methods included from Search::RelatedTags

#series_search_related_tags

Methods included from Search::Tags

#series_search_tags

Methods included from Release

#series_release

Methods included from Observations

#series_observations

Methods included from Categories

#series_categories

Instance Method Details

#series(opts = {}) ⇒ Hashie::Mash

Get an economic data series

Parameters:

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Options Hash (opts):

  • api_key (Integer) —

    32 character alpha-numeric lowercase string

  • file_type (String) —

    A key or file extension that indicates the type of file to send

  • series_id (Integer) —

    The id for a series

  • realtime_start (String) —

    The start of the real-time period

  • realtime_end (String) —

    The end of the real-time period

Returns:

  • (Hashie::Mash) —

    Hash containing the results



23
24
25
 
# File 'lib/fredapi/client/series.rb', line 23

def series opts={}
  get "fred/series", opts
end