# ex_ibge v0.4.0 - Table of Contents

Cliente Elixir para a API de Localidades e Agregados do IBGE.

## Pages

- [ExIbge](readme.md)
- [Guia de Localidades](localidades.md)
- [Guia de Agregados (Séries Históricas e Pesquisas)](agregados.md)
- [Guia de Nomes](nomes.md)
- [Guia do BNGB (Banco de Nomes Geográficos do Brasil)](bngb.md)
- [Guia do Calendário de Divulgações](calendario.md)
- [Guia de Contribuição](contributing.md)

## Modules

- [ExIbge](ExIbge.md): Documentation for `ExIbge`.

- [ExIbge.Aggregate](ExIbge.Aggregate.md): Module for handling IBGE Aggregates API (v3).
- [ExIbge.Aggregate.Aggregate](ExIbge.Aggregate.Aggregate.md)
- [ExIbge.Aggregate.Classification](ExIbge.Aggregate.Classification.md): Struct representing a classification from the Aggregates API.

- [ExIbge.Aggregate.Metadata](ExIbge.Aggregate.Metadata.md): Struct representing metadata for an aggregate.

- [ExIbge.Aggregate.Period](ExIbge.Aggregate.Period.md)
- [ExIbge.Aggregate.Research](ExIbge.Aggregate.Research.md)
- [ExIbge.Aggregate.Variable](ExIbge.Aggregate.Variable.md): Struct representing a variable from the Aggregates API.

- [ExIbge.Api](ExIbge.Api.md)
- [ExIbge.Bngb](ExIbge.Bngb.md): Module for handling IBGE BNGB API (v1) — Banco de Nomes Geográficos do Brasil.
- [ExIbge.Bngb.Category](ExIbge.Bngb.Category.md): Struct representing a BNGB category (EDGV 3.0).

- [ExIbge.Bngb.Class](ExIbge.Bngb.Class.md): Struct representing a BNGB class (EDGV 3.0).

- [ExIbge.Bngb.DictionaryEntry](ExIbge.Bngb.DictionaryEntry.md): Struct representing a BNGB dictionary entry with translations.

- [ExIbge.Bngb.GeoName](ExIbge.Bngb.GeoName.md): Struct representing a geographic name entry from the BNGB name list.

- [ExIbge.Bngb.GeographicName](ExIbge.Bngb.GeographicName.md): Struct representing a geographic name from the BNGB (Banco de Nomes Geográficos do Brasil).

- [ExIbge.Calendar](ExIbge.Calendar.md): Module for handling the IBGE Calendar API (v3) — Calendário de Divulgações.
- [ExIbge.Calendar.Release](ExIbge.Calendar.Release.md): Struct representing a release (divulgação) from the IBGE Calendar API.

- [ExIbge.Geography.Country](ExIbge.Geography.Country.md)
- [ExIbge.Geography.District](ExIbge.Geography.District.md)
- [ExIbge.Geography.ImmediateRegion](ExIbge.Geography.ImmediateRegion.md)
- [ExIbge.Geography.IntegratedDevelopmentRegion](ExIbge.Geography.IntegratedDevelopmentRegion.md)
- [ExIbge.Geography.IntermediateRegion](ExIbge.Geography.IntermediateRegion.md)
- [ExIbge.Geography.Mesoregion](ExIbge.Geography.Mesoregion.md)
- [ExIbge.Geography.MetropolitanRegion](ExIbge.Geography.MetropolitanRegion.md)
- [ExIbge.Geography.Microregion](ExIbge.Geography.Microregion.md)
- [ExIbge.Geography.Municipality](ExIbge.Geography.Municipality.md)
- [ExIbge.Geography.Region](ExIbge.Geography.Region.md)
- [ExIbge.Geography.State](ExIbge.Geography.State.md)
- [ExIbge.Geography.Subdistrict](ExIbge.Geography.Subdistrict.md)
- [ExIbge.Geography.UrbanAgglomeration](ExIbge.Geography.UrbanAgglomeration.md)
- [ExIbge.Locality.Country](ExIbge.Locality.Country.md): Module for handling Country (País) queries from IBGE.
- [ExIbge.Locality.District](ExIbge.Locality.District.md): Module for handling District (Distrito) queries from IBGE.
- [ExIbge.Locality.ImmediateRegion](ExIbge.Locality.ImmediateRegion.md): Module for handling Immediate Region (Região Imediata) queries from IBGE.
- [ExIbge.Locality.IntegratedDevelopmentRegion](ExIbge.Locality.IntegratedDevelopmentRegion.md): Module for handling Integrated Development Region (Região Integrada de Desenvolvimento - RIDE) queries from IBGE.
- [ExIbge.Locality.IntermediateRegion](ExIbge.Locality.IntermediateRegion.md): Module for handling Intermediate Region (Região Intermediária) queries from IBGE.
- [ExIbge.Locality.Mesoregion](ExIbge.Locality.Mesoregion.md): Module for handling Mesoregion (Mesorregião) queries from IBGE.
- [ExIbge.Locality.MetropolitanRegion](ExIbge.Locality.MetropolitanRegion.md): Module for handling Metropolitan Region (Região Metropolitana) queries from IBGE.
- [ExIbge.Locality.Microregion](ExIbge.Locality.Microregion.md): Module for handling Microregion (Microrregião) queries from IBGE.
- [ExIbge.Locality.Municipality](ExIbge.Locality.Municipality.md): Module for handling Municipality (Município) queries from IBGE.
- [ExIbge.Locality.Region](ExIbge.Locality.Region.md): Module for handling Region (Macrorregião) queries from IBGE.
- [ExIbge.Locality.State](ExIbge.Locality.State.md): Module for handling State (UF) queries from IBGE.
- [ExIbge.Locality.Subdistrict](ExIbge.Locality.Subdistrict.md): Module for handling Subdistrict (Subdistrito) queries from IBGE.
- [ExIbge.Locality.UrbanAgglomeration](ExIbge.Locality.UrbanAgglomeration.md): Module for handling Urban Agglomeration (Aglomeração Urbana) queries from IBGE.
- [ExIbge.Name](ExIbge.Name.md): Module for handling IBGE Names API (v2).
- [ExIbge.Name.Frequency](ExIbge.Name.Frequency.md): Struct representing the frequency of a name by decade.

- [ExIbge.Name.Ranking](ExIbge.Name.Ranking.md): Struct representing a name ranking response.

- [ExIbge.Query](ExIbge.Query.md)
- [ExIbge.Utils](ExIbge.Utils.md)