Module: FREDAPI::Client::Releases

Includes:

Dates

Included in:

FREDAPI::Client

Defined in:

lib/fredapi/client/releases.rb,
lib/fredapi/client/releases/dates.rb

Overview

Releases module for fred/releases endpoint

Defined Under Namespace

Modules: Dates

Instance Method Summary

• #releases(opts = {}) ⇒ Hashie::Mash

  Get all releases of economic data.

Methods included from Dates

#releases_dates

Instance Method Details

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

Get all releases 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

• category_id (Integer) —

  The id for a category

• 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

# File 'lib/fredapi/client/releases.rb', line 21

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