{"id":15750779,"url":"https://github.com/guibranco/cepaberto","last_synced_at":"2026-01-05T09:10:13.688Z","repository":{"id":37875754,"uuid":"144894233","full_name":"guibranco/CEPAberto","owner":"guibranco","description":"🇧🇷 :round_pushpin: CEPAberto API client wrapper for .NET projects","archived":false,"fork":false,"pushed_at":"2024-04-08T07:06:14.000Z","size":390,"stargazers_count":4,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-09T07:38:47.155Z","etag":null,"topics":["api","cep","cepaberto","csharp","ddd","geolocation","hacktoberfest","ibge","nuget","wrapper"],"latest_commit_sha":null,"homepage":"https://guibranco.github.io/CEPAberto/","language":"C#","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/guibranco.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}},"created_at":"2018-08-15T19:21:33.000Z","updated_at":"2024-07-16T17:20:58.368Z","dependencies_parsed_at":"2023-12-25T08:29:21.108Z","dependency_job_id":"fba0077b-a788-4afc-95f1-b94610eafc04","html_url":"https://github.com/guibranco/CEPAberto","commit_stats":{"total_commits":60,"total_committers":3,"mean_commits":20.0,"dds":"0.16666666666666663","last_synced_commit":"87ae32b5e79da771a4dad379bf2293c93ba2e9d4"},"previous_names":[],"tags_count":251,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guibranco%2FCEPAberto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guibranco%2FCEPAberto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guibranco%2FCEPAberto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guibranco%2FCEPAberto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guibranco","download_url":"https://codeload.github.com/guibranco/CEPAberto/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243422877,"owners_count":20288539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","cep","cepaberto","csharp","ddd","geolocation","hacktoberfest","ibge","nuget","wrapper"],"created_at":"2024-10-04T06:42:42.046Z","updated_at":"2026-01-05T09:10:13.676Z","avatar_url":"https://github.com/guibranco.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CEP Aberto SDK .NET\n\n[CEP Aberto](htttp://www.cepaberto.com) API wrapper written in C# (.NET).\n\nImplements all V3 features\n\n\n[![GitHub license](https://img.shields.io/github/license/guibranco/CEPAberto)](https://github.com/guibranco/CEPAberto)\n[![time tracker](https://wakatime.com/badge/github/guibranco/CEPAberto.svg)](https://wakatime.com/badge/github/guibranco/CEPAberto)\n[![DeepSource](https://deepsource.io/gh/guibranco/CEPAberto.svg/?label=active)](https://deepsource.io/gh/guibranco/CEPAberto/?ref=repository-badge)\n\n![CEPAberto](https://raw.githubusercontent.com/guibranco/CEPAberto/main/logo.png)\n\n## CI/CD\n\n| Build status | Last commit | Tests | Coverage | Code Smells | LOC |\n|--------------|-------------|-------|----------|-------------|-----|\n| [![Build status](https://ci.appveyor.com/api/projects/status/l9cuqk1s1gdppqpn/branch/main?svg=true)](https://ci.appveyor.com/project/guibranco/CEPAberto) | [![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/CEPAberto/main)](https://github.com/guibranco/CEPAberto) | [![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/guibranco/CEPAberto/main?compact_message)](https://ci.appveyor.com/project/guibranco/CEPAberto) | [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto) | [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=code_smells)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto) | [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=ncloc)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n\n## Code Quality\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e9fd678b9bfe4d729e8970ed3fb506d9)](https://www.codacy.com/gh/guibranco/CEPAberto/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=guibranco/CEPAberto\u0026amp;utm_campaign=Badge_Grade)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/e9fd678b9bfe4d729e8970ed3fb506d9)](https://www.codacy.com/gh/guibranco/CEPAberto/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=guibranco/CEPAberto\u0026amp;utm_campaign=Badge_Grade)\n\n[![codecov](https://codecov.io/gh/guibranco/CEPAberto/branch/main/graph/badge.svg)](https://codecov.io/gh/guibranco/CEPAberto)\n[![CodeFactor](https://www.codefactor.io/repository/github/guibranco/CEPAberto/badge)](https://www.codefactor.io/repository/github/guibranco/CEPAberto)\n\n[![Maintainability](https://api.codeclimate.com/v1/badges/f12c9899307a319a1cc4/maintainability)](https://codeclimate.com/github/guibranco/CEPAberto/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/f12c9899307a319a1cc4/test_coverage)](https://codeclimate.com/github/guibranco/CEPAberto/test_coverage)\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=sqale_index)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=bugs)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CEPAberto\u0026metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=guibranco_CEPAberto)\n\n---\n\n## Installation\n\n### Github Releases\n\n[![GitHub last release](https://img.shields.io/github/release-date/guibranco/CEPAberto.svg?style=flat)](https://github.com/guibranco/CEPAberto) [![Github All Releases](https://img.shields.io/github/downloads/guibranco/CEPAberto/total.svg?style=flat)](https://github.com/guibranco/CEPAberto)\n\nDownload the latest zip file from the [Release](https://github.com/GuiBranco/CEPAberto/releases) page.\n\n### Nuget package manager\n\n| Package | Version | Downloads |\n|------------------|:-------:|:-------:|\n| **CEPAberto** | [![CEPAberto NuGet Version](https://img.shields.io/nuget/v/CEPAberto.svg?style=flat)](https://www.nuget.org/packages/CEPAberto/) | [![CEPAberto NuGet Downloads](https://img.shields.io/nuget/dt/CEPAberto.svg?style=flat)](https://www.nuget.org/packages/CEPAberto/) |\n\n---\n\n## Features\n\nThis client supports the following operations/features of the API V3:\n\n1. Get data based on postal code (CEP).\n2. Get data of a nearest geo location (lat/lon) (Max of 10km).\n3. Get data based on state initials (UF), city, neighborhood and street/address.\n4. Get list of cities of a state based on state initials.\n5. Update the postal code (CEP).\n\n ---\n\n## Setup the CEPAbertoClient\n\nInitializes a new instance of **CEPAbertoClient** class.\nThe API token can be found at [http://www.cepaberto.com/api_key](http://www.cepaberto.com/api_key) (A free registration is required!)\n\n```cs\n\nvar client = new CEPAbertoClient(\"my API token\");\n//var postalData = client.GetData(\"00000000\");\n//var cities = client.GetCities(\"SP\");\n\n```\n\n## Get data based on postal code (CEP)\n\nSearches for a postal code data based on postal code\n\n ```cs\n\nvar client = new CEPAbertoClient(\"my API key\");\nvar postalCode = \"40010000\";\nvar result = client.GetData(postalCode);\n\nif(result.Success)\n{\n    Console.WriteLine(\"Postal data for the zip code {0} found!\", postalCode);\n    Console.WriteLine(\"Lat: {0} | Lon: {1}\", result.Latitude, result.Longitude);\n}\nelse\n    Console.WriteLine(\"No data for the zip code {0} available\", postalCode);\n\n```\n\n### Get data of a nearest geo location (lat/lon) (Max of 10km)\n\nSearches for the first postal code closest to the requested coordinates, limited to 10km (API limit, not library)\n\n ```cs\n\nvar client = new CEPAbertoClient(\"my API key\");\nvar result = client.GetData(\"-20.55\", \"-43.63\");\n\nif(result.Success)\n    Console.WriteLine(\"Postal code found: {0}\", result.PostalCode);\nelse\n    Console.WriteLine(\"Unable to find a postal data for the coordinates supplied!\");\n\n```\n\n## Get data based on state initials (UF), city, neighborhood and street/address\n\nSearches for a postal code data for the address supplied. Neighborhood and Street/Address are optional!\n\n```cs\n\nvar client = new CEPAbertoClient(\"my API key\");\nvar result = client.GetData(\"SP\",\"Ubatuba\");\n\nif(result.Success)\n    Console.WriteLine(\"Postal code found: {0}\", result.PostalCode);\nelse\n    Console.WriteLine(\"Cannot find postal code for Ubatuba/SP\");\n\n```\n\n## Get list of cities of a state based on state initials\n\nGet a list of cities for a given state (use state initials aka UF)\n\n```cs\n\nvar client = new CEPAbertoClient(\"my API key\");\nvar result = client.GetCities(\"AM\");\n\nif(result.Success)\n    foreach(var city in result.Cities)\n        Console.WriteLine(\"Found city {0} in Amazonas (AM)\", city.Name);\n\n```\n\n## Update the postal code (CEP)\n\nRequest an update on postal codes that may be outdated or not registered.\nAccepts upon 100 postal codes (CEP)\n\n```cs\n\nvar client = new CEPAbertoClient(\"my API key\");\nvar result = client.Update(\"03177010\");\n\nif(result.Success)\n    Console.WriteLine(\"Success on request update on postal code 03177-010\");\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguibranco%2Fcepaberto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguibranco%2Fcepaberto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguibranco%2Fcepaberto/lists"}