Module: FREDAPI::Client::Category::Children

Included in:
FREDAPI::Client::Category
Defined in:
lib/fredapi/client/category/children.rb

Overview

Category module for fred/category/children endpoint

Instance Method Summary collapse

Instance Method Details

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

Get the child categories for a specified parent 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



16
17
18
 
# File 'lib/fredapi/client/category/children.rb', line 16

def category_children opts={}
  get "fred/category/children", opts
end