Module: FREDAPI::Client::Category::Tags

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

Overview

Tags module for fred/category/tags endpoint

Instance Method Summary collapse

Instance Method Details

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

Get the tags 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

  • tag_group_id (String) —

    A tag group id to filter tags by type

  • tag_names (String) —

    A semicolon delimited list of tags to find related tags for

  • search_text (String) —

    The words to find matching tags with

  • 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



23
24
25
 
# File 'lib/fredapi/client/category/tags.rb', line 23

def category_tags opts={}
  get "fred/category/tags", opts
end