Get Started - leandrosdias/IBGE.Helper GitHub Wiki

Para realizar a requisição é necessário instancia a classe ibgeClient e utilizar seu métodos para realizar as requisições.

Use the namespace: IBGE.Helper

API de Localidades

A API permite acesso às divisões político-administrativas do Brasil. Ex:

var ibgeClient = new ibgeLocalidadeClient();

Municípios

Municípios

Retorna a lista de todos os municípios cadastrados.

Ex:

var ibgeClient = new ibgeLocalidadeClient();
var municipios = await ibgeClient.GetMunicipiosAsync();

Municípios por Identificador

Retorna a lista de todos os municípios utilizando um ou mais identificadores como consulta.

Ex:

var ibgeClient = new ibgeClient();
var municipios = await ibgeClient.GetMunicipiosByIdAsync(new List<int> { 1600303 });

Municípios por UF

Retorna a lista de todos os municípios utilizando um ou mais identificadores da UF como consulta.

Ex:

var ibgeClient = new ibgeLocalidadeClient();
var municipios = await ibgeClient.GetMunicipiosByUfAsync(new List<int> { 33 });

Municípios por Mesorregião

Retorna a lista de todos os municípios utilizando um ou mais identificadores da mesorregião como consulta.

Ex:

var ibgeClient = new ibgeLocalidadeClient();
var municipios = await ibgeClient.GetMunicipiosByMesorregiaoAsync(new List<int> { 3301 });

Municípios por Microrregião

Retorna a lista de todos os municípios utilizando um ou mais identificadores da microrregião como consulta.

Ex:

var ibgeClient = new ibgeLocalidadeClient();
var municipios = await ibgeClient.GetMunicipiosByMicrorregiaoAsync(new List<int> { 33001 });

Municípios por Região

Retorna a lista de todos os municípios utilizando um ou mais identificadores da região como consulta.

Ex:

var ibgeClient = new ibgeLocalidadeClient();
var municipios = await ibgeClient.GetMunicipiosByRegionAsync(new List<int> { 3 });
⚠️ **GitHub.com Fallback** ⚠️