@spec frequency(String.t() | [String.t()], Keyword.t()) ::
  {:ok, [ExIbge.Name.Frequency.t()]} | {:error, any()}

Get the frequency of births by decade for the given name(s).

Parameters

• names - A single name or a list of names.
• query - Optional parameters:
  • sex: Filter by sex ("M" for male, "F" for female).
  • group_by: Group results by geographic level (only "UF" is valid). Only works with a single name.
  • locality: Filter by locality ID or atom (e.g., "BR", "33", :rj, "3300100").

Examples

iex> ExIbge.Name.frequency("joao")
{:ok, [%ExIbge.Name.Frequency{name: "JOAO", ...}]}

iex> ExIbge.Name.frequency(["joao", "maria"])
{:ok, [%ExIbge.Name.Frequency{name: "JOAO", ...}, %ExIbge.Name.Frequency{name: "MARIA", ...}]}

iex> ExIbge.Name.frequency("ariel", sex: "F")
{:ok, [%ExIbge.Name.Frequency{name: "ARIEL", sex: "F", ...}]}

iex> ExIbge.Name.frequency("joao", locality: :rj)
{:ok, [%ExIbge.Name.Frequency{name: "JOAO", locality: "33", ...}]}

See Also

IBGE API: Nomes

@spec frequency!(String.t() | [String.t()], Keyword.t()) :: [
  ExIbge.Name.Frequency.t()
]

Same as frequency/2, but raises an error on failure.

@spec ranking(Keyword.t()) :: {:ok, [ExIbge.Name.Ranking.t()]} | {:error, any()}

Get the ranking of names by frequency of births.

Parameters

• query - Optional parameters:
  • decade: Filter by decade of birth (e.g., "1950", "1980").
  • locality: Filter by locality ID or atom (e.g., "BR", :rj, "3300100").
  • sex: Filter by sex ("M" for male, "F" for female).

Examples

iex> ExIbge.Name.ranking()
{:ok, [%ExIbge.Name.Ranking{locality: "BR", ...}]}

iex> ExIbge.Name.ranking(decade: "1950")
{:ok, [%ExIbge.Name.Ranking{...}]}

iex> ExIbge.Name.ranking(locality: :sp, sex: "F")
{:ok, [%ExIbge.Name.Ranking{locality: "35", sex: "F", ...}]}

See Also

IBGE API: Ranking de Nomes

@spec ranking!(Keyword.t()) :: [ExIbge.Name.Ranking.t()]

Same as ranking/1, but raises an error on failure.