Module: FREDAPI::Client::Release

Includes:
Dates, RelatedTags, Series, Sources, Tags
Included in:
FREDAPI::Client
Defined in:
lib/fredapi/client/release.rb,
lib/fredapi/client/release/tags.rb,
lib/fredapi/client/release/dates.rb,
lib/fredapi/client/release/series.rb,
lib/fredapi/client/release/sources.rb,
lib/fredapi/client/release/related_tags.rb

Overview

Release module for fred/release endpoint

Defined Under Namespace

Modules: Dates, RelatedTags, Series, Sources, Tags

Instance Method Summary collapse

Methods included from RelatedTags

#release_related_tags

Methods included from Tags

#release_tags

Methods included from Sources

#release_sources

Methods included from Series

#release_series

Methods included from Dates

#release_dates

Instance Method Details

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

Get a release of economic data

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

  • release_id (Integer) —

    The id for a release

  • 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



21
22
23
 
# File 'lib/fredapi/client/release.rb', line 21

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