Brasilapi.Brokers.API (BrasilAPI v0.1.5)

View Source

Client for BrasilAPI Brokers (Brokerage Firms) endpoints.

Provides functions to fetch information about CVM-registered brokerage firms.

Summary

Functions

Fetches a specific brokerage firm by its CNPJ from CVM records.

Fetches all active brokerage firms registered with CVM.

Functions

get_broker_by_cnpj(cnpj)

@spec get_broker_by_cnpj(String.t() | integer()) ::
  {:ok, Brasilapi.Brokers.Broker.t()} | {:error, map()}

Fetches a specific brokerage firm by its CNPJ from CVM records.

Returns detailed information about a specific broker registered with CVM including all registration data, financial information, and contact details.

Parameters

  • cnpj - The CNPJ number (string or integer, with or without formatting)

Examples

iex> Brasilapi.Brokers.API.get_broker_by_cnpj("02332886000104")
{:ok, %Brasilapi.Brokers.Broker{cnpj: "02332886000104", nome_social: "XP INVESTIMENTOS CCTVM S.A.", ...}}

iex> Brasilapi.Brokers.API.get_broker_by_cnpj("02.332.886/0001-04")
{:ok, %Brasilapi.Brokers.Broker{cnpj: "02332886000104", nome_social: "XP INVESTIMENTOS CCTVM S.A.", ...}}

iex> Brasilapi.Brokers.API.get_broker_by_cnpj(2332886000104)
{:ok, %Brasilapi.Brokers.Broker{cnpj: "02332886000104", nome_social: "XP INVESTIMENTOS CCTVM S.A.", ...}}

iex> Brasilapi.Brokers.API.get_broker_by_cnpj("00000000000000")
{:error, %{status: 404, message: "Não foi encontrado este CNPJ na listagem da CVM."}}

get_brokers()

@spec get_brokers() :: {:ok, [Brasilapi.Brokers.Broker.t()]} | {:error, map()}

Fetches all active brokerage firms registered with CVM.

Returns a list of all active brokers with complete registration information including CNPJ, names, addresses, contact information, and financial data.

Examples

iex> Brasilapi.Brokers.API.get_brokers()
{:ok, [%Brasilapi.Brokers.Broker{cnpj: "00000000000191", nome_social: "CORRETORA EXEMPLO S.A.", ...}]}

iex> Brasilapi.Brokers.API.get_brokers()
{:error, %{status: 500, message: "Internal server error"}}