Packages

brasilapi

1.0.1
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 brokers.ex
Raw

lib/brasilapi/brokers.ex 

defmodule Brasilapi.Brokers do

  @moduledoc """

  Brokers (Brokerage Firms) module for BrasilAPI.



  This module provides the main interface for CVM (Securities and Exchange Commission of Brazil)

  registered brokerage firms, allowing users to get information about active brokers.

  """



  alias Brasilapi.Brokers.API



  @doc """

  Gets all active brokerage firms registered with CVM.



  Delegates to `Brasilapi.Brokers.API.get_brokers/0`.

  """

  defdelegate get_brokers(), to: API



  @doc """

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



  Delegates to `Brasilapi.Brokers.API.get_broker_by_cnpj/1`.

  """

  defdelegate get_broker_by_cnpj(cnpj), to: API

end