Module: FREDAPI::Client::Releases::Dates

Included in:

FREDAPI::Client::Releases

Defined in:

lib/fredapi/client/releases/dates.rb

Overview

Dates module for fred/releases/dates endpoint

Instance Method Summary

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

  Get releases dates for all releases of economic data.

Instance Method Details

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

Get releases dates for 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

• 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

• include_release_dates_with_no_data (Integer) —

  Determines whether release dates with no data available are returned.

Returns:

• (Hashie::Mash) —

  Hash containing the results

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

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