{"id":39540236,"url":"https://github.com/felipefrizzo/brazilian-zipcode-api","last_synced_at":"2026-01-18T06:36:20.732Z","repository":{"id":57626872,"uuid":"211540996","full_name":"felipefrizzo/brazilian-zipcode-api","owner":"felipefrizzo","description":"An API for Brazilian postal codes, where will be available to consult the addresses by zipcode.","archived":false,"fork":false,"pushed_at":"2025-09-01T17:05:49.000Z","size":95,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-01T19:08:34.059Z","etag":null,"topics":["api-rest","correios","correios-cep","golang","postal-codes"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/felipefrizzo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-09-28T17:57:16.000Z","updated_at":"2025-09-01T17:05:47.000Z","dependencies_parsed_at":"2023-12-24T20:20:02.852Z","dependency_job_id":"72140686-d148-4fc6-9de6-b00a64f54931","html_url":"https://github.com/felipefrizzo/brazilian-zipcode-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/felipefrizzo/brazilian-zipcode-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefrizzo%2Fbrazilian-zipcode-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefrizzo%2Fbrazilian-zipcode-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefrizzo%2Fbrazilian-zipcode-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefrizzo%2Fbrazilian-zipcode-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/felipefrizzo","download_url":"https://codeload.github.com/felipefrizzo/brazilian-zipcode-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipefrizzo%2Fbrazilian-zipcode-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28531997,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","correios","correios-cep","golang","postal-codes"],"created_at":"2026-01-18T06:36:19.996Z","updated_at":"2026-01-18T06:36:20.700Z","avatar_url":"https://github.com/felipefrizzo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🇧🇷 Brazilian Zipcode API\n\nA fast and extensible API to retrieve Brazilian address information by ZIP code (CEP), with support for multiple storage backends, TTL caching, and third-party provider integration.\n\n---\n\n## ✨ Features\n\n- 🔍 Fetch address data using a Brazilian CEP (zipcode)\n- 🧠 Cache layer with configurable TTL using Redis\n- 🗄️ Plug-and-play support for multiple storage backends (e.g. Redis, PostgreSQL, MongoDB)\n- ♻️ Automatic cache invalidation and rehydration from third-party APIs (e.g. Correios)\n- 🧱 Clean Architecture for scalability and maintainability\n- 🚦 Built-in healthcheck endpoint\n- 🔧 Configurable via `.env` using Viper\n\n---\n\n## 📦 Installation\n\n```bash\n\u003e git clone https://github.com/felipefrizzo/brazilian-zipcode-api.git\n\u003e cd brazilian-zipcode-api\n\u003e go build -o zipcode-api ./cmd/*\n\u003e go run ./cmd/*\n```\n\nServer runs on :8080 by default.\n\n## 🔧 Configuration\n\nCreate a .env file:\n\n```bash\nPORT=8080\n\nREDIS_HOST=redis\nREDIS_PORT=6379\nREDIS_USERNAME=\nREDIS_PASSWORD=\nREDIS_DB=0\n\nCACHE_TTL_SECONDS=3600\n```\n\n## 📘 API Endpoints\n\n#### Healthcheck\n\n```bash\n\u003e curl http://localhost:8080/health\n```\n\n#### Get Address by Zipcode\n\n```bash\n\u003e curl http://localhost:8080/zipcode/01001000\n\n{\n  \"federative_unit\": \"PR\",\n  \"city\": \"Cascavel\",\n  \"neighborhood\": \"Centro\",\n  \"address_name\": \"Avenida Brasil\",\n  \"complement\": \"- de 5623 a 6869 - lado ímpar\",\n  \"zipcode\": \"85801000\",\n}\n```\n\n## 🧱 Architecture\n\n- cmd/ — Application entry point\n- internal/ — Domain logic and interfaces\n  - address/ — Domain model + repository interface\n  - address/redis — Redis implementation of address repository\n  - address/postgres — PostgreSQL implementation of address repository\n  - zipcode/ — API handler\n  - server/ — HTTP server initialization\n  - config/ — Viper-based config loader\n\n## 📈 Roadmap\n\n1. Correios API integration\n1. PostgreSQL and MongoDB support\n1. OpenAPI documentation\n1. Rate limiting and metrics\n\n## 🤝 Contributing\n\nPRs are welcome. Ensure code is clean, covered by tests, and follows idiomatic Go practices.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelipefrizzo%2Fbrazilian-zipcode-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffelipefrizzo%2Fbrazilian-zipcode-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelipefrizzo%2Fbrazilian-zipcode-api/lists"}