Module: FREDAPI::Client::Series::VintageDates

Included in:
FREDAPI::Client::Series
Defined in:
lib/fredapi/client/series/vintage_dates.rb

Overview

VintageDates module for fred/series/vintagedates endpoint

Instance Method Summary collapse

Instance Method Details

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

Get the dates in history when a series’ data values were revised or new data values were released

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

  • limit (Integer)

    The maximum number of results to return

  • offset (Integer)

    Non-negative integer

  • sort_order (String)

    Sort results is ascending or descending order for attribute values specified by order_by

Returns:

  • (Hashie::Mash)

    Hash containing the results



20
21
22
# File 'lib/fredapi/client/series/vintage_dates.rb', line 20

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