Module: FREDAPI::Client::Source

Includes:

Releases

Included in:

FREDAPI::Client

Defined in:

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

Overview

Source module for fred/source endpoint

Defined Under Namespace

Modules: Releases

Instance Method Summary

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

  Get a source of economic data.

Methods included from Releases

#source_releases

Instance Method Details

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

Get a source 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

• source_id (Integer) —

  The id for a source

• 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

# File 'lib/fredapi/client/source.rb', line 17

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