Brasilapi.Feriados.API (BrasilAPI v0.1.5)

View Source

Client for BrasilAPI Feriados endpoints.

Provides functions to fetch information about Brazilian national holidays for a specific year. Calculates movable holidays based on Easter and includes fixed holidays.

Summary

Functions

Fetches national holidays for a specific year.

Functions

get_by_year(year)

@spec get_by_year(String.t() | integer()) ::
  {:ok, [Brasilapi.Feriados.Holiday.t()]} | {:error, map()}

Fetches national holidays for a specific year.

Lists national holidays for the given year. Calculates movable holidays based on Easter and adds fixed holidays.

Parameters

  • year - The year as string or integer. Must be within supported range.

Examples

iex> Brasilapi.Feriados.API.get_by_year(2021)
{:ok, [
  %Brasilapi.Feriados.Holiday{
    date: "2021-01-01",
    name: "Confraternização mundial",
    type: "national",
    full_name: nil
  },
  # ... more holidays
]}

iex> Brasilapi.Feriados.API.get_by_year(1900)
{:error, %{status: 404, message: "Ano fora do intervalo suportado."}}