🇧🇷 BrasilAPI

Transformando o acesso a dados públicos no Brasil. Uma API de código aberto, rápida e resiliente para desenvolvedores brasileiros.

---

🚀 Funcionalidades Atuais

A BrasilAPI centraliza diversos serviços de consulta pública em uma interface única e padronizada:

Serviço	Descrição	Status
BANKS	Consulta de códigos ISPB, nomes e códigos bancários do sistema financeiro nacional.	✅ Ativo
CEP / CEP-V2	Busca de endereços por CEP com múltiplos providers (fallback) e geolocalização.	✅ Ativo
DDD	Informações sobre estados e cidades vinculadas a cada código de área DDD.	✅ Ativo
CAMBIO (Novo)	Cotações oficiais do Banco Central (PTAX) com fallback inteligente para dias úteis.	✨ Novo

---

✨ O que há de novo (v1.0.1)

💱 API de Câmbio

Consulta de cotações de moedas integradas diretamente ao Olinda PTAX do Banco Central.

• Lista de Moedas: Obtenha todos os símbolos suportados.
• Inteligência de Fallback: Se você consultar um final de semana, a API automaticamente busca a cotação do último dia útil disponível.
• Normalização: Conversão automática de parâmetros (ex: usd -> USD).

🧪 Suite de Testes

Implementamos uma cobertura de testes robusta utilizando o Bun Test, garantindo que as APIs continuem funcionando mesmo com mudanças futuras no upstream.

---

🛠️ Stack Tecnológica

• Runtime: Bun (Performance ultra-rápida)
• API Framework: ElysiaJS (Type safety & Swagger integrado)
• Documentation: Fumadocs & Next.js 15
• Styling: Tailwind CSS & Biome (lint/format)

---

👨‍💻 Como Começar

Pré-requisitos

• Bun instalado localmente.

Instalação

# Clone o repositório
git clone https://github.com/felix01sa/BrasilAPI.git

# Instale as dependências
bun install

# Execute em modo desenvolvimento
bun run dev

Executando Testes

# Rodar todos os testes
bun test

---

📖 Documentação

Nossa documentação completa é gerada automaticamente e pode ser acessada em: http://localhost:3000/docs (ou via Swagger em /api/swagger)

---

🤝 Contribuição

Contribuições são o que fazem a comunidade open source um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.

1. Faça um Fork do projeto
2. Crie sua Feature Branch (git checkout -b feature/AmazingFeature)
3. Faça o Commit de suas alterações (git commit -m 'Add some AmazingFeature')
4. Faça o Push para a Branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

---

📄 Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Feito com ❤️ por desenvolvedores brasileiros para desenvolvedores brasileiros.