Module: FREDAPI::Client::Series::Categories

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

Overview

Categories module for fred/series/categories endpoint

Instance Method Summary collapse

Instance Method Details

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

Get the categories 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

Returns:

  • (Hashie::Mash) —

    Hash containing the results



16
17
18
 
# File 'lib/fredapi/client/series/categories.rb', line 16

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