ViaCep 4.1.444

dotnet add package ViaCep --version 4.1.444
NuGet\Install-Package ViaCep -Version 4.1.444
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.444" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ViaCep --version 4.1.444
#r "nuget: ViaCep, 4.1.444"
#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.444

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

ViaCEP SDK .NET

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

GitHub license time tracker

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 CodeFactor

Maintainability Test Coverage

Quality Gate Status Maintainability Rating

Technical Debt Duplicated Lines (%)

Reliability Rating Security Rating

Bugs Vulnerabilities

DeepSource


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-07-28: Add integration tests #71 by @Riju-bak
  • 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.444 77 2/19/2024
4.1.441 63 2/19/2024
4.1.429 80 2/14/2024
4.1.423 96 2/12/2024
4.1.420 186 1/30/2024
4.1.417 133 1/29/2024
4.1.411 198 1/16/2024
4.1.408 159 1/16/2024
4.1.401 167 1/15/2024
4.1.394 198 1/8/2024
4.1.386 290 12/25/2023
4.1.383 252 12/25/2023
4.1.378 272 12/18/2023
4.1.373 259 12/14/2023
4.1.367 277 12/12/2023
4.1.364 265 12/12/2023
4.1.354 264 12/11/2023
4.1.345 318 12/4/2023
4.1.342 275 12/4/2023
4.1.337 315 12/4/2023
4.1.334 301 11/28/2023
4.1.331 295 11/21/2023
4.1.328 254 11/21/2023
4.1.323 281 11/21/2023
4.1.316 325 11/14/2023
4.1.311 284 11/14/2023
4.1.305 275 11/14/2023
4.1.300 289 11/10/2023
4.1.290 289 11/6/2023
4.1.287 292 11/6/2023
4.1.282 356 10/31/2023
4.1.276 1,655 10/18/2023
4.1.273 330 10/17/2023
4.1.268 298 10/17/2023
4.1.261 495 9/19/2023
4.1.258 358 9/18/2023
4.1.253 468 9/5/2023
4.1.250 357 9/5/2023
4.1.241 785 8/24/2023
4.1.238 433 8/14/2023
4.1.235 450 8/9/2023
4.1.232 490 8/1/2023
4.1.229 487 8/1/2023
4.1.224 482 8/1/2023
4.1.217 475 7/31/2023
4.1.208 492 7/29/2023
4.1.203 462 7/28/2023
4.1.196 459 7/28/2023
4.1.190 527 7/24/2023
4.1.188 506 7/24/2023
4.1.184 516 7/24/2023
4.1.149 489 7/17/2023
4.1.146 502 7/11/2023
4.1.143 491 7/11/2023
4.1.138 466 7/3/2023
4.1.135 497 6/15/2023
4.1.132 517 6/6/2023
4.1.131 460 6/6/2023
4.1.128 477 6/6/2023
4.1.123 722 5/24/2023
4.1.120 475 5/24/2023
4.1.115 463 5/24/2023
4.1.104 446 5/4/2023
4.1.101 468 5/3/2023
4.1.96 563 4/9/2023
4.1.92 521 4/4/2023
4.1.87 515 3/25/2023
4.1.79 517 3/23/2023
4.1.76 653 3/3/2023
4.1.73 522 3/3/2023
4.1.57 545 3/3/2023
4.1.54 669 1/24/2023
4.1.53 678 1/15/2023
4.1.48 605 1/15/2023
4.1.45 598 1/14/2023
4.1.40 584 1/14/2023
3.2.35 591 1/14/2023
3.2.32 629 12/25/2022
3.2.27 569 12/25/2022
3.2.19 15,956 6/21/2021
3.1.5 8,353 10/23/2020
3.0.40 5,293 4/18/2020
3.0.38 1,494 4/7/2020
3.0.30 862 3/30/2020
3.0.23 880 3/29/2020
3.0.15 881 3/29/2020
3.0.12 834 3/29/2020
3.0.9 953 3/28/2020
2.0.93 1,849 3/28/2020
2.0.92 919 3/28/2020
2.0.89 895 3/28/2020
2.0.88 901 3/28/2020
2.0.80 949 3/28/2020
2.0.64 6,005 12/30/2019
2.0.61 11,084 12/3/2019
2.0.58 1,691 9/22/2019
2.0.48 2,873 2/15/2019
2.0.47 1,084 2/15/2019
1.0.0 1,021 2/15/2019