Module: FREDAPI::Client::Category::Related

Included in:

FREDAPI::Client::Category

Defined in:

lib/fredapi/client/category/related.rb

Overview

Related module for fred/category/related endpoint

Instance Method Summary

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

  Get the related categories for a category.

Instance Method Details

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

Get the related categories for a category

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

Returns:

• (Hashie::Mash) —

  Hash containing the results

# File 'lib/fredapi/client/category/related.rb', line 16

def category_related opts={}
  get "fred/category/related", opts
end