Brasilapi.Rates.API (BrasilAPI v0.1.5)

View Source

Client for BrasilAPI Rates endpoints.

Provides functions to fetch information about Brazilian tax rates and official indices.

Summary

Functions

Fetches information about all available tax rates and indices.

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

Functions

get_all()

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

Fetches information about all available tax rates and indices.

Examples

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

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

get_by_acronym(acronym)

@spec get_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_by_acronym("CDI")
{:ok, %Brasilapi.Taxas.Rate{nome: "CDI", valor: 14.9}}

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