Brasilapi.Cnpj.API (BrasilAPI v0.1.5)

Client for BrasilAPI CNPJ endpoints.

Provides functions to fetch information about Brazilian companies by CNPJ.

Summary

Functions

Fetches information about a company by its CNPJ.

Functions

get_by_cnpj(cnpj)

@spec get_by_cnpj(String.t() | integer()) ::
  {:ok, Brasilapi.Cnpj.Company.t()} | {:error, map()}

Fetches information about a company by its CNPJ.

Parameters

cnpj - The CNPJ number (string or integer)

Examples

iex> Brasilapi.Cnpj.API.get_by_cnpj("11000000000197")
{:ok, %Brasilapi.Cnpj.Company{cnpj: "11000000000197", razao_social: "ACME INC"}}

iex> Brasilapi.Cnpj.API.get_by_cnpj("00000000000000")
{:error, %{status: 404, message: "Not found"}}