@spec children(category_id :: integer(), opts :: keyword()) :: Fred.Client.response()

Get the child categories for a specified parent category.

Options

• :realtime_end (struct of type Date) - End of the real-time period.

• :realtime_start (struct of type Date) - Start of the real-time period.

Examples

iex> {:ok, children} = Fred.Categories.children(0)
iex> %{"categories" => [_ | _]} = children

iex> {:error, %Fred.Error{type: :option_error}} =
...>   Fred.Categories.children(0, realtime_start: "Bad Input")

@spec get(category_id :: integer(), opts :: keyword()) :: Fred.Client.response()

Get a category.

Options

• :realtime_end (struct of type Date) - End of the real-time period.

• :realtime_start (struct of type Date) - Start of the real-time period.

Examples

iex> {:ok, category} = Fred.Categories.get(125)
iex> %{
...>   "categories" => [
...>     %{"id" => 125, "name" => "Trade Balance", "parent_id" => 13}
...>   ]
...> } = category

iex> {:error, %Fred.Error{type: :option_error}} =
...>   Fred.Categories.get(125, realtime_start: "Bad Input")

@spec related(category :: integer(), opts :: keyword()) :: Fred.Client.response()

Get the related categories for a given category.

A related category is a one-way relation between two categories that is not part of the parent-child tree structure.

Options

• :realtime_end (struct of type Date) - End of the real-time period.

• :realtime_start (struct of type Date) - Start of the real-time period.

Examples

iex> {:ok, categories} = Fred.Categories.related(32073)
iex> %{"categories" => [_ | _]} = categories

iex> {:error, %Fred.Error{type: :option_error}} =
...>   Fred.Categories.related(32073, realtime_start: "Bad Input")

@spec related_tags(category :: integer(), opts :: keyword()) :: Fred.Client.response()

Get the related FRED tags for a category.

Related tags are tags assigned to series that match all tags in :tag_names.

Options

• :exclude_tag_names (list of String.t/0) - List of tag names to exclude.

• :filter_value (String.t/0) - The value of the filter_variable attribute to filter results by. This requires that the :filter_variable is also provided.

• :filter_variable (atom/0) - The attribute to filter results by. Supported values are:

  • :frequency
  • :units
  • :seasonal_adjustment

• :limit (pos_integer/0) - Max results (between 1-1000).

• :offset (pos_integer/0) - Result offset.

• :order_by (atom/0) - Order the results by the provided field. Supported values are:

  • :series_count
  • :popularity
  • :created
  • :name
  • :group_id

• :realtime_end (struct of type Date) - End of the real-time period.

• :realtime_start (struct of type Date) - Start of the real-time period.

• :search_text (String.t/0) - Text to search tag names.

• :sort_order (atom/0) - The sort order of the results. Supported values are:

  • :asc
  • :desc

• :tag_group_id (atom/0) - Tag group filter. Supported values are:

  • :freq - Frequency
  • :gen - General or Concept
  • :geo - Geography
  • :geot - Geography Type
  • :rls - Release
  • :seas - Seasonal Adjustment
  • :src - Source

• :tag_names (list of String.t/0) - List of tag names to match.

Examples

iex> {:ok, tags} = Fred.Categories.related_tags(125, tag_names: ["services", "quarterly"])
iex> %{"tags" => [_ | _]} = tags

@spec series(category :: integer(), opts :: keyword()) :: Fred.Client.response()

Get the series in a category.

Options

• :exclude_tag_names (list of String.t/0) - List of tag names to exclude.

• :filter_value (String.t/0) - The value of the filter_variable attribute to filter results by. This requires that the :filter_variable is also provided.

• :filter_variable (atom/0) - The attribute to filter results by. Supported values are:

  • :frequency
  • :units
  • :seasonal_adjustment

• :limit (pos_integer/0) - Max results (between 1-1000).

• :offset (pos_integer/0) - Result offset.

• :order_by (atom/0) - Order the results by the provided field. Supported values are:

  • :series_id
  • :title
  • :units
  • :frequency
  • :seasonal_adjustment
  • :realtime_start
  • :realtime_end
  • :last_updated
  • :observation_start
  • :observation_end
  • :popularity
  • :group_popularity

• :realtime_end (struct of type Date) - End of the real-time period.

• :realtime_start (struct of type Date) - Start of the real-time period.

• :sort_order (atom/0) - The sort order of the results. Supported values are:

  • :asc
  • :desc

• :tag_names (list of String.t/0) - List of tag names to match.

Examples

iex> {:ok, series} = Fred.Categories.series(125, limit: 10, order_by: :popularity, sort_order: :desc)
iex> %{"seriess" => [_ | _]} = series

@spec tags(category :: integer(), opts :: keyword()) :: Fred.Client.response()

Get the FRED tags for a category.

Options

• :filter_value (String.t/0) - The value of the filter_variable attribute to filter results by. This requires that the :filter_variable is also provided.

• :filter_variable (atom/0) - The attribute to filter results by. Supported values are:

  • :frequency
  • :units
  • :seasonal_adjustment

• :limit (pos_integer/0) - Max results (between 1-1000).

• :offset (pos_integer/0) - Result offset.

• :order_by (atom/0) - Order the results by the provided field. Supported values are:

  • :series_count
  • :popularity
  • :created
  • :name
  • :group_id

• :realtime_end (struct of type Date) - End of the real-time period.

• :realtime_start (struct of type Date) - Start of the real-time period.

• :search_text (String.t/0) - Text to search tag names.

• :sort_order (atom/0) - The sort order of the results. Supported values are:

  • :asc
  • :desc

• :tag_group_id (atom/0) - Tag group filter. Supported values are:

  • :freq - Frequency
  • :gen - General or Concept
  • :geo - Geography
  • :geot - Geography Type
  • :rls - Release
  • :seas - Seasonal Adjustment
  • :src - Source

• :tag_names (list of String.t/0) - List of tag names to match.

Examples

iex> {:ok, tags} = Fred.Categories.tags(125, tag_group_id: :freq)
iex> %{"tags" => [_ | _]} = tags