# BrasilAPI v1.0.2 - Table of Contents 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. ## Pages - [README](readme.md) - [Changelog](changelog.md) ## Modules - [Brasilapi](Brasilapi.md): A simple Elixir client for BrasilAPI. - [Brasilapi.Banks](Brasilapi.Banks.md): Banks domain module for BrasilAPI. - [Brasilapi.Banks.API](Brasilapi.Banks.API.md): Client for BrasilAPI Banks endpoints. - [Brasilapi.Banks.Bank](Brasilapi.Banks.Bank.md): Represents a Brazilian bank with its identifying information. - [Brasilapi.Brokers](Brasilapi.Brokers.md): Brokers (Brokerage Firms) module for BrasilAPI. - [Brasilapi.Brokers.API](Brasilapi.Brokers.API.md): Client for BrasilAPI Brokers (Brokerage Firms) endpoints. - [Brasilapi.Brokers.Broker](Brasilapi.Brokers.Broker.md): Represents a CVM-registered brokerage firm with complete registration information. - [Brasilapi.Cep](Brasilapi.Cep.md): Cep domain module for BrasilAPI. - [Brasilapi.Cep.API](Brasilapi.Cep.API.md): Client for BrasilAPI CEP endpoints. - [Brasilapi.Cep.Address](Brasilapi.Cep.Address.md): Struct representing address data from BrasilAPI CEP v2. - [Brasilapi.Client](Brasilapi.Client.md): HTTP client for BrasilAPI endpoints. - [Brasilapi.Cnpj](Brasilapi.Cnpj.md): CNPJ domain module for BrasilAPI. - [Brasilapi.Cnpj.API](Brasilapi.Cnpj.API.md): Client for BrasilAPI CNPJ endpoints. - [Brasilapi.Cnpj.Company](Brasilapi.Cnpj.Company.md): Represents a company data structure from the CNPJ API. - [Brasilapi.Config](Brasilapi.Config.md): Configuration module for BrasilAPI client. - [Brasilapi.Cptec](Brasilapi.Cptec.md): CPTEC domain module for BrasilAPI. - [Brasilapi.Cptec.API](Brasilapi.Cptec.API.md): Client for BrasilAPI CPTEC (Centro de Previsão de Tempo e Estudos Climáticos) endpoints. - [Brasilapi.Cptec.AirportConditions](Brasilapi.Cptec.AirportConditions.md): Struct representing current weather conditions at an airport. Used for both capital weather and specific airport weather data. - [Brasilapi.Cptec.City](Brasilapi.Cptec.City.md): Struct representing a city from CPTEC city search. - [Brasilapi.Cptec.CityForecast](Brasilapi.Cptec.CityForecast.md): Struct representing a city weather forecast. Contains the city information and an array of climate data for multiple days. - [Brasilapi.Cptec.ClimateData](Brasilapi.Cptec.ClimateData.md): Struct representing daily climate/weather forecast data. - [Brasilapi.Cptec.DailyWaves](Brasilapi.Cptec.DailyWaves.md): Struct representing daily wave data containing hourly wave conditions. - [Brasilapi.Cptec.HourlyWaves](Brasilapi.Cptec.HourlyWaves.md): Struct representing hourly wave conditions for ocean forecast. - [Brasilapi.Cptec.OceanForecast](Brasilapi.Cptec.OceanForecast.md): Struct representing an ocean/wave forecast for a city. Contains the city information and an array of daily wave data. - [Brasilapi.Ddd](Brasilapi.Ddd.md): DDD domain module for BrasilAPI. - [Brasilapi.Ddd.API](Brasilapi.Ddd.API.md): Client for BrasilAPI DDD endpoints. - [Brasilapi.Ddd.Info](Brasilapi.Ddd.Info.md): Struct representing DDD information from BrasilAPI DDD v1. - [Brasilapi.Exchange](Brasilapi.Exchange.md): Exchange Rate module for BrasilAPI. - [Brasilapi.Exchange.API](Brasilapi.Exchange.API.md): Client for BrasilAPI Exchange Rate endpoints. - [Brasilapi.Exchange.Currency](Brasilapi.Exchange.Currency.md): Represents a currency available for exchange rate queries. - [Brasilapi.Exchange.DailyExchangeRate](Brasilapi.Exchange.DailyExchangeRate.md): Represents daily exchange rate information for a specific currency and date. - [Brasilapi.Exchange.ExchangeRate](Brasilapi.Exchange.ExchangeRate.md): Represents a single exchange rate quotation with buy/sell rates and metadata. - [Brasilapi.Fipe](Brasilapi.Fipe.md): FIPE domain module for BrasilAPI. - [Brasilapi.Fipe.API](Brasilapi.Fipe.API.md): Client for BrasilAPI FIPE endpoints. - [Brasilapi.Fipe.Brand](Brasilapi.Fipe.Brand.md): Struct representing a vehicle brand in the FIPE table. - [Brasilapi.Fipe.Price](Brasilapi.Fipe.Price.md): Struct representing vehicle price information from the FIPE table. - [Brasilapi.Fipe.ReferenceTable](Brasilapi.Fipe.ReferenceTable.md): Struct representing a FIPE reference table. - [Brasilapi.Fipe.Vehicle](Brasilapi.Fipe.Vehicle.md): Struct representing a vehicle model in the FIPE table. - [Brasilapi.Holidays](Brasilapi.Holidays.md): Holidays domain module for BrasilAPI. - [Brasilapi.Holidays.API](Brasilapi.Holidays.API.md): Client for BrasilAPI Holidays endpoints. - [Brasilapi.Holidays.Holiday](Brasilapi.Holidays.Holiday.md): Struct representing a national holiday. - [Brasilapi.Ibge](Brasilapi.Ibge.md): IBGE domain module for BrasilAPI. - [Brasilapi.Ibge.API](Brasilapi.Ibge.API.md): Client for BrasilAPI IBGE endpoints. - [Brasilapi.Ibge.Municipality](Brasilapi.Ibge.Municipality.md): Struct representing a Brazilian municipality (município). - [Brasilapi.Ibge.Region](Brasilapi.Ibge.Region.md): Struct representing a Brazilian region. - [Brasilapi.Ibge.State](Brasilapi.Ibge.State.md): Struct representing a Brazilian state (Unidade Federativa). - [Brasilapi.Isbn](Brasilapi.Isbn.md): ISBN (International Standard Book Number) module for BrasilAPI. - [Brasilapi.Isbn.API](Brasilapi.Isbn.API.md): Client for BrasilAPI ISBN endpoints. - [Brasilapi.Isbn.Book](Brasilapi.Isbn.Book.md): Represents a book with complete information from ISBN lookup. - [Brasilapi.Isbn.Dimensions](Brasilapi.Isbn.Dimensions.md): Represents book dimensions with width, height, and measurement unit. - [Brasilapi.Ncm](Brasilapi.Ncm.md): NCM domain module for BrasilAPI. - [Brasilapi.Ncm.API](Brasilapi.Ncm.API.md): Client for BrasilAPI NCM endpoints. - [Brasilapi.Ncm.Ncm](Brasilapi.Ncm.Ncm.md): Struct representing an NCM (Nomenclatura Comum do Mercosul) code. - [Brasilapi.Pix](Brasilapi.Pix.md): PIX domain module for BrasilAPI. - [Brasilapi.Pix.API](Brasilapi.Pix.API.md): Client for BrasilAPI PIX endpoints. - [Brasilapi.Pix.Participant](Brasilapi.Pix.Participant.md): Represents a PIX participant with their information from the Brazilian instant payment system. - [Brasilapi.Rates](Brasilapi.Rates.md): Rates domain module for BrasilAPI. - [Brasilapi.Rates.API](Brasilapi.Rates.API.md): Client for BrasilAPI Rates endpoints. - [Brasilapi.Rates.Rate](Brasilapi.Rates.Rate.md): Represents a Brazilian tax rate or official index with its value. - [Brasilapi.RegistroBr](Brasilapi.RegistroBr.md): RegistroBR domain module for BrasilAPI. - [Brasilapi.RegistroBr.API](Brasilapi.RegistroBr.API.md): Client for BrasilAPI RegistroBR endpoints. - [Brasilapi.RegistroBr.Domain](Brasilapi.RegistroBr.Domain.md): Represents a Brazilian domain (.br) with its registration information. - [Brasilapi.Utils.Cnpj](Brasilapi.Utils.Cnpj.md): Utilities for CNPJ (Cadastro Nacional da Pessoa Jurídica) handling. - [Brasilapi.Utils.Isbn](Brasilapi.Utils.Isbn.md): Utilities for ISBN (International Standard Book Number) handling.