Module: FREDAPI::Client::Tags::Series

Included in:
FREDAPI::Client::Tags
Defined in:
lib/fredapi/client/tags/series.rb

Overview

Series module for fred/tags/series endpoint

Instance Method Summary collapse

Instance Method Details

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

Get the series matching tags

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

  • tag_names (String) —

    A semicolon delimited list of tags to find related tags for

  • 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

  • order_by (String) —

    Order results by values of the specified attribute

  • 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/tags/series.rb', line 20

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