Pular para conteúdo

ibge

IBGEClient

Cliente para a API de Localidades do IBGE.

get_states async

get_states()

Consulta todos os estados (Unidades da Federação).

get_state async

get_state(uf)

Consulta um estado específico pela sua sigla (UF).

get_municipalities async

get_municipalities(uf=None)

Consulta todos os municípios, opcionalmente filtrados por UF.

get_municipality async

get_municipality(code)

Consulta um município específico por código.

client

IBGEClient

Cliente para a API de Localidades do IBGE.

get_states async

get_states()

Consulta todos os estados (Unidades da Federação).

get_state async

get_state(uf)

Consulta um estado específico pela sua sigla (UF).

get_municipalities async

get_municipalities(uf=None)

Consulta todos os municípios, opcionalmente filtrados por UF.

get_municipality async

get_municipality(code)

Consulta um município específico por código.

tools

Funções de tool para o módulo IBGE.

consultar_municipios_ibge async

consultar_municipios_ibge(uf=None)

Consulta municípios brasileiros, opcionalmente filtrados por UF.

Parameters:

Name Type Description Default
uf str | None

Sigla do estado com 2 letras (ex: 'GO', 'SP'). Se omitida, retorna todos.

None

Returns:

Type Description
list[Municipio]

Lista de Municipio com id, nome, microrregião e estado.

Raises:

Type Description
FiscalValidationError

Se a sigla de UF for inválida.

consultar_estado_ibge async

consultar_estado_ibge(uf)

Consulta os dados de um estado brasileiro pela sigla da UF.

Parameters:

Name Type Description Default
uf str

Sigla do estado com 2 letras (ex: 'GO', 'SP', 'RJ').

required

Returns:

Type Description
Estado

Estado com id, sigla, nome e região.

Raises:

Type Description
FiscalValidationError

Se a sigla de UF for inválida.