CEPAberto 3.0.435

There is a newer version of this package available.
See the version list below for details.
dotnet add package CEPAberto --version 3.0.435
NuGet\Install-Package CEPAberto -Version 3.0.435
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CEPAberto" Version="3.0.435" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CEPAberto --version 3.0.435
#r "nuget: CEPAberto, 3.0.435"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CEPAberto as a Cake Addin
#addin nuget:?package=CEPAberto&version=3.0.435

// Install CEPAberto as a Cake Tool
#tool nuget:?package=CEPAberto&version=3.0.435

CEP Aberto

CEP Aberto API wrapper written in C# (.NET).

Implements all V3 features

GitHub license time tracker

CEPAberto

CI/CD

Build status Last commit Tests Coverage Code Smells LOC
Build status GitHub last commit AppVeyor tests (branch) Coverage Code Smells Lines of Code

Code Quality

Codacy Badge Codacy Badge

codecov CodeFactor

Maintainability Test Coverage

Quality Gate Status Maintainability Rating

Technical Debt Duplicated Lines (%)

Reliability Rating Security Rating

Bugs Vulnerabilities


Installation

Github Releases

GitHub last release Github All Releases

Download the latest zip file from the Release page.

Nuget package manager

Package Version Downloads
CEPAberto CEPAberto NuGet Version CEPAberto NuGet Downloads

Features

This client supports the following operations/features of the API V3:

  1. Get data based on postal code (CEP).
  2. Get data of a nearest geo location (lat/lon) (Max of 10km).
  3. Get data based on state initials (UF), city, neighborhood and street/address.
  4. Get list of cities of a state based on state initials.
  5. Update the postal code (CEP).

Setup the CEPAbertoClient

Initializes a new instance of CEPAbertoClient class. The API token can be found at http://www.cepaberto.com/api_key (A free registration is required!)


var client = new CEPAbertoClient("my API token");
//var postalData = client.GetData("00000000");
//var cities = client.GetCities("SP");

Get data based on postal code (CEP)

Searches for a postal code data based on postal code


var client = new CEPAbertoClient("my API key");
var postalCode = "40010000";
var result = client.GetData(postalCode);

if(result.Success)
{
   Console.WriteLine("Postal data for the zip code {0} found!", postalCode);
   Console.WriteLine("Lat: {0} | Lon: {1}", result.Latitude, result.Longitude);
}
else
   Console.WriteLine("No data for the zip code {0} available", postalCode);

Get data of a nearest geo location (lat/lon) (Max of 10km)

Searches for the first postal code closest to the requested coordinates, limited to 10km (API limit, not library)


var client = new CEPAbertoClient("my API key");
var result = client.GetData("-20.55", "-43.63");

if(result.Success)
   Console.WriteLine("Postal code found: {0}", result.PostalCode);
else
   Console.WriteLine("Unable to find a postal data for the coordinates supplied!");

Get data based on state initials (UF), city, neighborhood and street/address

Searches for a postal code data for the address supplied. Neighborhood and Street/Address are optional!


var client = new CEPAbertoClient("my API key");
var result = client.GetData("SP","Ubatuba");

if(result.Success)
    Console.WriteLine("Postal code found: {0}", result.PostalCode);
else
    Console.WriteLine("Cannot find postal code for Ubatuba/SP");

Get list of cities of a state based on state initials

Get a list of cities for a given state (use state initials aka UF)


var client = new CEPAbertoClient("my API key");
var result = client.GetCities("AM");

if(result.Success)
    foreach(var city in result.Cities)
        Console.WriteLine("Found city {0} in Amazonas (AM)", city.Name);

Update the postal code (CEP)

Request an update on postal codes that may be outdated or not registered. Accepts upon 100 postal codes (CEP)


var client = new CEPAbertoClient("my API key");
var result = client.Update("03177010");

if(result.Success)
    Console.WriteLine("Success on request update on postal code 03177-010");

Product Compatible and additional computed target framework versions.
.NET Framework net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.210 71 2/26/2024
4.0.207 66 2/26/2024
4.0.202 63 2/26/2024
4.0.193 70 2/19/2024
4.0.186 60 2/19/2024
4.0.177 61 2/19/2024
4.0.160 73 2/14/2024
4.0.154 63 2/12/2024
4.0.151 56 2/12/2024
4.0.148 61 2/6/2024
4.0.145 67 2/5/2024
4.0.140 76 1/30/2024
4.0.135 63 1/29/2024
4.0.132 64 1/29/2024
4.0.127 66 1/29/2024
4.0.120 67 1/29/2024
4.0.112 77 1/22/2024
4.0.107 68 1/22/2024
4.0.104 59 1/22/2024
4.0.99 71 1/22/2024
4.0.90 71 1/16/2024
4.0.82 68 1/15/2024
4.0.77 73 1/15/2024
4.0.70 83 1/8/2024
4.0.67 77 1/8/2024
4.0.62 116 12/25/2023
4.0.59 89 12/25/2023
4.0.54 93 12/25/2023
4.0.47 84 12/25/2023
4.0.38 98 12/18/2023
4.0.35 89 12/18/2023
4.0.32 93 12/18/2023
4.0.25 79 12/18/2023
4.0.3 105 12/17/2023
3.0.467 97 12/14/2023
3.0.461 102 12/12/2023
3.0.458 112 12/11/2023
3.0.455 98 12/11/2023
3.0.452 109 12/11/2023
3.0.445 132 12/5/2023
3.0.440 113 12/5/2023
3.0.435 118 11/28/2023
3.0.432 101 11/28/2023
3.0.427 125 11/23/2023
3.0.424 105 11/21/2023
3.0.417 174 11/14/2023
3.0.411 84 11/14/2023
3.0.408 106 11/14/2023
3.0.400 126 11/10/2023
3.0.391 110 11/7/2023
3.0.388 108 11/7/2023
3.0.385 134 10/24/2023
3.0.382 114 10/17/2023
3.0.378 142 9/25/2023
3.0.373 123 9/24/2023
3.0.370 117 9/24/2023
3.0.365 122 9/24/2023
3.0.356 136 9/17/2023
3.0.353 120 9/17/2023
3.0.348 151 9/13/2023
3.0.338 145 9/13/2023
3.0.335 130 9/13/2023
3.0.332 134 9/13/2023
3.0.322 303 8/28/2023
3.0.314 321 8/13/2023
3.0.311 133 8/13/2023
3.0.308 151 8/13/2023
3.0.301 156 8/13/2023
3.0.291 233 8/3/2023
3.0.288 174 8/2/2023
3.0.283 200 7/28/2023
3.0.280 165 7/25/2023
3.0.277 156 7/25/2023
3.0.269 216 7/19/2023
3.0.266 139 7/19/2023
3.0.212 320 6/27/2023
3.0.209 206 6/26/2023
3.0.202 225 6/19/2023
3.0.193 158 6/18/2023
3.0.188 167 6/18/2023
3.0.183 156 6/18/2023
3.0.166 325 6/7/2023
3.0.156 323 5/31/2023
3.0.150 142 5/31/2023
3.0.147 158 5/31/2023
3.0.117 144 5/25/2023
3.0.114 410 5/4/2023
3.0.113 165 5/2/2023
3.0.109 179 4/28/2023
3.0.102 359 4/10/2023
3.0.97 190 4/9/2023
3.0.89 204 4/4/2023
3.0.84 327 4/3/2023
3.0.75 352 3/27/2023
3.0.72 273 3/25/2023
3.0.65 221 3/25/2023
3.0.56 223 3/25/2023
2.0.39 584 1/24/2023
2.0.38 658 1/9/2023
2.0.33 302 1/9/2023
2.0.32 297 1/9/2023
2.0.31 290 1/9/2023
2.0.26 331 12/14/2022
2.0.25 321 12/8/2022
2.0.24 321 12/8/2022
2.0.21 328 12/8/2022
2.0.12 1,197 11/1/2020
2.0.11 506 10/1/2020
2.0.10 578 9/1/2020
2.0.9 520 8/1/2020
2.0.8 674 7/1/2020
2.0.7 499 6/29/2020
1.0.58 624 6/1/2020
1.0.57 581 5/2/2020
1.0.56 574 5/2/2020
1.0.54 595 5/2/2020
1.0.52 539 5/2/2020
1.0.51 566 5/2/2020
1.0.50 582 5/2/2020
1.0.49 626 5/2/2020
1.0.48 563 5/2/2020
1.0.47 567 5/2/2020
1.0.46 583 5/1/2020
1.0.45 586 5/1/2020
1.0.44 570 5/1/2020
1.0.43 589 5/1/2020
1.0.42 556 5/1/2020
1.0.41 567 5/1/2020
1.0.40 593 5/1/2020
1.0.39 573 5/1/2020
1.0.38 581 5/1/2020
1.0.37 628 5/1/2020
1.0.36 552 5/1/2020
1.0.35 568 5/1/2020
1.0.34 566 5/1/2020
1.0.33 573 5/1/2020
1.0.32 537 5/1/2020
1.0.31 556 5/1/2020
1.0.30 537 5/1/2020
1.0.29 560 5/1/2020
1.0.28 552 5/1/2020
1.0.27 581 5/1/2020
1.0.26 612 5/1/2020
1.0.25 663 5/1/2020
1.0.24 592 5/1/2020
1.0.22 619 5/1/2020
1.0.21 547 4/24/2020
1.0.20 575 4/24/2020
1.0.19 552 4/24/2020
1.0.12 935 9/19/2018
1.0.9 922 8/16/2018
1.0.8 914 8/16/2018