@spec get_rates() :: {:ok, [Brasilapi.Rates.Rate.t()]} | {:error, map()}

Fetches information about all available tax rates and indices.

Examples

iex> Brasilapi.Rates.API.get_rates()
{:ok, [%Brasilapi.Rates.Rate{nome: "CDI", valor: 14.9}]}

iex> Brasilapi.Rates.API.get_rates()
{:error, %{reason: :timeout}}

API Reference

https://brasilapi.com.br/docs#tag/TAXAS/paths/~1taxas~1v1/get

@spec get_rates_by_acronym(String.t()) ::
  {:ok, Brasilapi.Rates.Rate.t()} | {:error, map()}

Fetches information about a specific tax rate or index by its name/acronym.

Parameters

• acronym - The tax rate or index name/acronym (string)

Examples

iex> Brasilapi.Rates.API.get_rates_by_acronym("CDI")
{:ok, %Brasilapi.Taxas.Rate{nome: "CDI", valor: 14.9}}

iex> Brasilapi.Rates.API.get_rates_by_acronym("INVALID")
{:error, %{status: 404, message: "Not found"}}

API Reference

https://brasilapi.com.br/docs#tag/TAXAS/paths/~1taxas~1v1~1%7Bsigla%7D/get