brasilapi

0.1.0

1.0.3 1.0.2 1.0.1 1.0.0 0.1.5 0.1.4 0.1.3 0.1.1 0.1.0

A simple Elixir client for BrasilAPI, a public API that provides access to various Brazilian data such as postal codes, banks, states, cities, and more.

HexDocs

Current section

Files

Jump to

Readme 9 Versions 2 Dependencies Dependants Files Activity

brasilapi lib brasilapi cep.ex

Raw

lib/brasilapi/cep.ex

defmodule Brasilapi.Cep do
  @moduledoc """
  Cep domain module for BrasilAPI.

  This module provides the main interface for CEP-related functionality.
  """

  alias Brasilapi.Cep.API

  @doc """
  Fetches information about a CEP using the v2 endpoint with multiple providers.

  Delegates to `Brasilapi.Cep.API.get_by_cep/1`.
  """
  defdelegate get_by_cep(cep), to: API
end

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".