Brasil API Client for Python
Project description
BrasilApy
Um cliente da Brasil API em python3. Link do repositório oficial.
Nesta versão 1.0.0
esse cliente possui suporte a autocomplete por meio de Typed Hints. Todos as respostas são traduzidas para objetos do Pydantic, que trazem previsibilidade ao explorar a API através da sua IDE favorita.
Instalação
Rode o comando pip install brasilapy
e estará tudo pronto.
A versão do python que é compativel com essa biblioteca é a 3.10+
.
Documentação
Documentação oficial da API com todas as chamadas poderão se encontradas neste link.
Código de exemplo
Para efetuar as consultas na API, basta instanciar a classe e fazer as consultas.
from brasilapy import BrasilAPI
client = BrasilAPI()
estado = client.get_ibge_estado(state_uf="pb")
print(estado.id)
print(estado.regiao)
print(estado.sigla)
###
# para um caso mais complexo, temos
###
from brasilapy.constants import IBGEProvider
municipios = client.get_ibge_municipios(state_uf="pb", providers=(IBGEProvider.DADOS_ABERTOS_BR,))
for municipio in municipios:
print(municipio.nome)
print(municipio.codigo_ibge)
Métodos disponíveis do BrasilAPI
Método | Detalhes |
---|---|
get_banks() | |
get_bank(code: str) | |
get_cep(test_cep: str, api_version: APIVersion) | |
get_cnpj(test_cnpj: str) | |
get_ddd(test_ddd: str) | |
get_feriados(year: int) | |
get_fipe_veiculos(tipo_veiculos: FipeTipoVeiculo, tabela_referencia: int) | |
get_fipe_precos(codigo_fipe: str, tabela_referencia: int) | |
get_fipe_tabelas() | |
get_ibge_municipios(state_uf: str, providers: tuple[IBGEProvider] | |
get_ibge_estados() | |
get_registro_br_domain(fqdn: str) | |
get_taxas_juros() | |
get_taxa_juros(taxa: TaxaJurosType) |
Os tipos de dados APIVersion
, FipeTipoVeiculo
, IBGEProvider
e TaxaJurosType
são classes de constants que podem ser importadas através do seguinte comando:
from brasilapy.constants import APIVersion, FipeTipoVeiculo, IBGEProvider, TaxaJurosType
Autores
Filipe Soares | Jonhnatha Trigueiro |
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for brasilapy-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5c4c9471df4305b4e615750f20b2c8dbd0e84635702fed4d9a4eb7c8516c045 |
|
MD5 | a08630e11c424510c78e7769c4ceda7e |
|
BLAKE2b-256 | 3aa57e77ff154ce613d78b2cbdb80d1e26f48aacb4cf9153889a242bb5096b6f |