Module: FREDAPI::Client::Series::Observations

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

Overview

Observations module for fred/series/observations endpoint

Instance Method Summary collapse

Instance Method Details

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

Get the observations or data values for 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

  • 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

  • observation_start (String) —

    The start of the observation period

  • observation_end (String) —

    The end of the observation period

  • units (String) —

    A key that indicates a data value transformation

  • frequency (String) —

    An optional parameter that indicates a lower frequency to aggregate values to.

  • aggregation_method (String) —

    A key that indicates the aggregation method used for frequency aggregation

  • output_type (Integer) —

    An integer that indicates an output type

  • vintage_dates (String) —

    A comma separated string of YYYY-MM-DD formatted dates in history

Returns:

  • (Hashie::Mash) —

    Hash containing the results



26
27
28
 
# File 'lib/fredapi/client/series/observations.rb', line 26

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