Brasilapi.Brokers.Broker (BrasilAPI v0.1.5)

View Source

Represents a CVM-registered brokerage firm with complete registration information.

Summary

Functions

Creates a Broker struct from API response data.

Types

t()

@type t() :: %Brasilapi.Brokers.Broker{
  bairro: String.t(),
  cep: String.t(),
  cnpj: String.t(),
  codigo_cvm: String.t(),
  complemento: String.t(),
  data_inicio_situacao: String.t(),
  data_patrimonio_liquido: String.t(),
  data_registro: String.t(),
  email: String.t(),
  logradouro: String.t(),
  municipio: String.t(),
  nome_comercial: String.t(),
  nome_social: String.t(),
  pais: String.t(),
  status: String.t() | nil,
  telefone: String.t(),
  type: String.t() | nil,
  uf: String.t(),
  valor_patrimonio_liquido: String.t()
}

Functions

from_map(map)

@spec from_map(map()) :: t()

Creates a Broker struct from API response data.