ViaCep 4.1.76

There is a newer version of this package available.
See the version list below for details.
dotnet add package ViaCep --version 4.1.76
NuGet\Install-Package ViaCep -Version 4.1.76
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="ViaCep" Version="4.1.76" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ViaCep --version 4.1.76
#r "nuget: ViaCep, 4.1.76"
#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 ViaCep as a Cake Addin
#addin nuget:?package=ViaCep&version=4.1.76

// Install ViaCep as a Cake Tool
#tool nuget:?package=ViaCep&version=4.1.76

ViaCEP

A .NET client wrapper for both .NET Core & .NET Framework projects of Via CEP API

GitHub license

Via CEP

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

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
ViaCEP ViaCEP NuGet Version ViaCEP NuGet Downloads

Usage

The package has two classes:

This package is fully compatible with Dependency Injection. Use the interface IViaCepClient and the constructor with HttpClient parameter with a IHttpClientFactory instance.

//your DI container
services.AddHttpClient<IViaCepClient, ViaCepClient>(client => { client.BaseAddress = new Uri("https://viacep.com.br/"); });

//then use in your domain service, handler, controller...
var viaCepClient = container.GetService<IViaCepClient>();
var result = await viaCepClient.SearchAsync("01001000", cancellationToken);

You can search using the zip code/postal code (AKA CEP) or using the address data (state initials - UF, city name and location name - street, avenue, park, square). Both methods support async and sync!

Querying by zip code / postal code (single result)

var result = new ViaCepClient().Search("01001000"); //searches for the postal code 01001-000
var address = result.Address; //Praça da Sé
var city = reuslt.City; //São Paulo
//do what you need with 'result' instance of ViaCEPResult.

Querying by address (list result)

var results = new ViaCepClient().Search("SP", "São Paulo", "Avenida Paulista"); //search for the Avenida Paulista in São Paulo / SP
foreach(var result in results){
    var address = result.Address;
    var neighborhood = result.Neighborhood;
    var zipCode = result.ZipCode;
    //do what you need with 'result' instance of ViaCEPResult.
}

Changelog

  • 2023-03-03: Update dependencies, change branch name, update logo. @guibranco
  • 2021-06-21: Update dependencies version. @guibranco
  • 2020-10-23: Add support to .NET Standard 2.0 and .NET Framework v4.6.1 and above. @guibranco
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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.1.453 76 2/26/2024
4.1.449 63 2/26/2024
4.1.444 115 2/19/2024
4.1.441 90 2/19/2024
4.1.429 105 2/14/2024
4.1.423 120 2/12/2024
4.1.420 213 1/30/2024
4.1.417 156 1/29/2024
4.1.411 220 1/16/2024
4.1.408 182 1/16/2024
4.1.401 186 1/15/2024
4.1.394 219 1/8/2024
4.1.386 312 12/25/2023
4.1.383 275 12/25/2023
4.1.378 291 12/18/2023
4.1.373 280 12/14/2023
4.1.367 298 12/12/2023
4.1.364 289 12/12/2023
4.1.354 287 12/11/2023
4.1.345 341 12/4/2023
4.1.342 300 12/4/2023
4.1.337 338 12/4/2023
4.1.334 325 11/28/2023
4.1.331 315 11/21/2023
4.1.328 276 11/21/2023
4.1.323 303 11/21/2023
4.1.316 343 11/14/2023
4.1.311 308 11/14/2023
4.1.305 299 11/14/2023
4.1.300 312 11/10/2023
4.1.290 306 11/6/2023
4.1.287 314 11/6/2023
4.1.282 379 10/31/2023
4.1.276 1,678 10/18/2023
4.1.273 352 10/17/2023
4.1.268 319 10/17/2023
4.1.261 517 9/19/2023
4.1.258 381 9/18/2023
4.1.253 490 9/5/2023
4.1.250 380 9/5/2023
4.1.241 815 8/24/2023
4.1.238 455 8/14/2023
4.1.235 472 8/9/2023
4.1.232 513 8/1/2023
4.1.229 509 8/1/2023
4.1.224 506 8/1/2023
4.1.217 497 7/31/2023
4.1.208 515 7/29/2023
4.1.203 483 7/28/2023
4.1.196 481 7/28/2023
4.1.190 544 7/24/2023
4.1.188 528 7/24/2023
4.1.184 538 7/24/2023
4.1.149 512 7/17/2023
4.1.146 524 7/11/2023
4.1.143 514 7/11/2023
4.1.138 488 7/3/2023
4.1.135 527 6/15/2023
4.1.132 539 6/6/2023
4.1.131 480 6/6/2023
4.1.128 499 6/6/2023
4.1.123 746 5/24/2023
4.1.120 497 5/24/2023
4.1.115 485 5/24/2023
4.1.104 459 5/4/2023
4.1.101 491 5/3/2023
4.1.96 584 4/9/2023
4.1.92 550 4/4/2023
4.1.87 528 3/25/2023
4.1.79 538 3/23/2023
4.1.76 673 3/3/2023
4.1.73 539 3/3/2023
4.1.57 568 3/3/2023
4.1.54 692 1/24/2023
4.1.53 699 1/15/2023
4.1.48 628 1/15/2023
4.1.45 619 1/14/2023
4.1.40 602 1/14/2023
3.2.35 608 1/14/2023
3.2.32 650 12/25/2022
3.2.27 587 12/25/2022
3.2.19 16,036 6/21/2021
3.1.5 8,405 10/23/2020
3.0.40 5,318 4/18/2020
3.0.38 1,519 4/7/2020
3.0.30 886 3/30/2020
3.0.23 905 3/29/2020
3.0.15 904 3/29/2020
3.0.12 858 3/29/2020
3.0.9 977 3/28/2020
2.0.93 1,865 3/28/2020
2.0.92 934 3/28/2020
2.0.89 913 3/28/2020
2.0.88 917 3/28/2020
2.0.80 960 3/28/2020
2.0.64 6,027 12/30/2019
2.0.61 11,160 12/3/2019
2.0.58 1,702 9/22/2019
2.0.48 2,889 2/15/2019
2.0.47 1,099 2/15/2019
1.0.0 1,036 2/15/2019