Skip to content

lvcas-dotcom/API-Extract_ReceitaFederal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 API de Extração de Dados CNPJ & Simples Nacional

🔍 Uma API para extrair dados do CNPJ e do Simples Nacional diretamente da Receita Federal!


🛠️ Sobre o Projeto

Esta API permite a extração eficiente dos dados do CNPJ disponibilizados pela Receita Federal, incluindo informações do Simples Nacional. A versão original apresentava algumas desatualizações, então realizei melhorias e ajustes para garantir seu pleno funcionamento.

📌 Principais Atualizações:
✅ Correções em endpoints desatualizados
✅ Melhorias na performance da extração
✅ Ajustes para compatibilidade com versões recentes

📜 Todos os créditos estão no arquivo LICENSE.


🔄 Como Funciona?

1️⃣ Coleta: A API baixa os arquivos disponibilizados pela Receita Federal.
2️⃣ Extração: Os arquivos são descompactados na pasta especificada no script.
3️⃣ Banco de Dados: Conecta ao banco configurado.
4️⃣ Estruturação: Gera automaticamente as tabelas necessárias.
5️⃣ Carga: Insere os dados extraídos diretamente no banco.

📊 Estrutura do Banco

Estrutura do Banco


Estrutura do Projeto

.
|-- src/
|   |-- start_etl.py
|   |-- configs/
|   |   `-- .env_template
|   `-- etl/
|       |-- cli.py
|       |-- config.py
|       |-- logging_config.py
|       |-- db/
|       |   `-- postgres.py
|       |-- services/
|       |   |-- admin_service.py
|       |   `-- etl_service.py
|       |-- pipeline/
|       |   |-- download.py
|       |   |-- extract.py
|       |   `-- load.py
|       |-- ui/
|       |   |-- console.py
|       |   `-- menu.py
|       `-- schema/
|           `-- tables.py
|-- sql/
|   `-- banco_de_dados.sql
`-- requirements.txt

🚀 Como Usar (Linux)

1️⃣ Clone o repositório
2️⃣ Crie o arquivo .env a partir de src/configs/.env_template
3️⃣ Instale as dependências
4️⃣ Execute o pipeline

git clone https://github.com/lvcas-dotcom/API-Extract_ReceitaFederal.git
cd API-Extract_ReceitaFederal
cp src/configs/.env_template src/configs/.env
pip install -r requirements.txt
python src/start_etl.py --env src/configs/.env

Para abrir o menu interativo:

python src/start_etl.py

Para executar direto (sem menu):

python src/start_etl.py --no-menu

Alternativa:

cd src
python -m etl --env configs/.env

Configuração opcional

  • DATA_MONTH=YYYY-MM para fixar a competência (por padrão usa o último mês disponível).
  • DOWNLOAD_WORKERS para paralelizar downloads.
  • --no-drop para manter tabelas e inserir incrementalmente.
  • --create-db para criar a base e sair.
  • O script sql/banco_de_dados.sql pode ser usado para criar a base.

About

Dados Públicos de CNPJ disponibilizados pela Receita Federal do Brasil - Atualizado 2025

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages