ViaCep 4.1.511

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

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

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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ViaCep:

Package Downloads
DrCash.Application.SDK

Package Description

DrCash.Application

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.1.511 178 5/31/2024
4.1.510 71 5/28/2024
4.1.507 62 5/28/2024
4.1.502 70 5/28/2024
4.1.495 180 4/29/2024
4.1.492 87 4/29/2024
4.1.487 82 4/29/2024
4.1.480 101 4/22/2024
4.1.477 80 4/22/2024
4.1.474 117 4/15/2024
4.1.471 79 4/15/2024
4.1.466 125 4/8/2024
4.1.463 370 3/18/2024
4.1.460 136 3/18/2024
4.1.453 325 2/26/2024
4.1.449 194 2/26/2024
4.1.444 565 2/19/2024
4.1.441 208 2/19/2024
4.1.429 271 2/14/2024
4.1.423 253 2/12/2024
4.1.420 362 1/30/2024
4.1.417 273 1/29/2024
4.1.411 353 1/16/2024
4.1.408 303 1/16/2024
4.1.401 288 1/15/2024
4.1.394 346 1/8/2024
4.1.386 431 12/25/2023
4.1.383 388 12/25/2023
4.1.378 399 12/18/2023
4.1.373 407 12/14/2023
4.1.367 427 12/12/2023
4.1.364 407 12/12/2023
4.1.354 396 12/11/2023
4.1.345 450 12/4/2023
4.1.342 400 12/4/2023
4.1.337 475 12/4/2023
4.1.334 441 11/28/2023
4.1.331 426 11/21/2023
4.1.328 405 11/21/2023
4.1.323 440 11/21/2023
4.1.316 462 11/14/2023
4.1.311 407 11/14/2023
4.1.305 427 11/14/2023
4.1.300 447 11/10/2023
4.1.290 434 11/6/2023
4.1.287 424 11/6/2023
4.1.282 511 10/31/2023
4.1.276 2,054 10/18/2023
4.1.273 473 10/17/2023
4.1.268 431 10/17/2023
4.1.261 652 9/19/2023
4.1.258 510 9/18/2023
4.1.253 639 9/5/2023
4.1.250 491 9/5/2023
4.1.241 1,105 8/24/2023
4.1.238 574 8/14/2023
4.1.235 607 8/9/2023
4.1.232 635 8/1/2023
4.1.229 624 8/1/2023
4.1.224 635 8/1/2023
4.1.217 639 7/31/2023
4.1.208 621 7/29/2023
4.1.203 599 7/28/2023
4.1.196 598 7/28/2023
4.1.190 661 7/24/2023
4.1.188 644 7/24/2023
4.1.184 654 7/24/2023
4.1.149 632 7/17/2023
4.1.146 629 7/11/2023
4.1.143 656 7/11/2023
4.1.138 608 7/3/2023
4.1.135 661 6/15/2023
4.1.132 658 6/6/2023
4.1.131 598 6/6/2023
4.1.128 623 6/6/2023
4.1.123 901 5/24/2023
4.1.120 616 5/24/2023
4.1.115 601 5/24/2023
4.1.104 586 5/4/2023
4.1.101 605 5/3/2023
4.1.96 712 4/9/2023
4.1.92 661 4/4/2023
4.1.87 640 3/25/2023
4.1.79 659 3/23/2023
4.1.76 793 3/3/2023
4.1.73 662 3/3/2023
4.1.57 679 3/3/2023
4.1.54 816 1/24/2023
4.1.53 855 1/15/2023
4.1.48 747 1/15/2023
4.1.45 729 1/14/2023
4.1.40 735 1/14/2023
3.2.35 726 1/14/2023
3.2.32 775 12/25/2022
3.2.27 690 12/25/2022
3.2.19 19,513 6/21/2021
3.1.5 9,560 10/23/2020
3.0.40 6,287 4/18/2020
3.0.38 1,638 4/7/2020
3.0.30 1,013 3/30/2020
3.0.23 1,029 3/29/2020
3.0.15 1,021 3/29/2020
3.0.12 944 3/29/2020
3.0.9 1,087 3/28/2020
2.0.93 2,006 3/28/2020
2.0.92 1,060 3/28/2020
2.0.89 1,050 3/28/2020
2.0.88 1,059 3/28/2020
2.0.80 1,096 3/28/2020
2.0.64 6,197 12/30/2019
2.0.61 12,502 12/3/2019
2.0.58 1,836 9/22/2019
2.0.48 3,018 2/15/2019
2.0.47 1,232 2/15/2019
1.0.0 1,182 2/15/2019