ViaCep 4.1.511

.NET Standard 2.0

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.

<PackageVersion Include="ViaCep" Version="4.1.511" />
                    

                            Directory.Packages.props

<PackageReference Include="ViaCep" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add ViaCep --version 4.1.511

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#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.

#:package ViaCep@4.1.511

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=ViaCep&version=4.1.511
                    

                            Install as a Cake Addin

#tool nuget:?package=ViaCep&version=4.1.511
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ViaCEP SDK .NET

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

CI/CD

Build status	Last commit	Tests	Coverage	Code Smells	LOC

Code Quality

Installation

Github Releases

Download the latest zip file from the Release page.

Nuget package manager

Package	Version	Downloads
ViaCEP

Usage

The package has two classes:

ViaCepClient: The main class (methods).
ViaCepResult: The result class (data).

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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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.

.NETStandard 2.0
- Microsoft.AspNet.WebApi.Client (>= 6.0.0)
- Newtonsoft.Json (>= 13.0.3)
.NETStandard 2.1
- Microsoft.AspNet.WebApi.Client (>= 6.0.0)
- Newtonsoft.Json (>= 13.0.3)

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ViaCep:

Package	Downloads
DrCash.Application Package Description	216
DrCash.Application.SDK Package Description	213

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
4.1.511	6,385	5/31/2024
4.1.510	392	5/28/2024
4.1.507	379	5/28/2024
4.1.502	382	5/28/2024
4.1.495	540	4/29/2024
4.1.492	390	4/29/2024
4.1.487	397	4/29/2024
4.1.480	392	4/22/2024
4.1.477	386	4/22/2024
4.1.474	418	4/15/2024
4.1.471	391	4/15/2024
4.1.466	450	4/8/2024
4.1.463	768	3/18/2024
4.1.460	460	3/18/2024
4.1.453	683	2/26/2024
4.1.449	494	2/26/2024
4.1.444	1,840	2/19/2024
4.1.441	513	2/19/2024
4.1.429	582	2/14/2024
4.1.423	579	2/12/2024
4.1.420	666	1/30/2024
4.1.417	584	1/29/2024
4.1.411	654	1/16/2024
4.1.408	605	1/16/2024
4.1.401	590	1/15/2024
4.1.394	633	1/8/2024
4.1.386	736	12/25/2023
4.1.383	682	12/25/2023
4.1.378	702	12/18/2023
4.1.373	697	12/14/2023
4.1.367	716	12/12/2023
4.1.364	705	12/12/2023
4.1.354	698	12/11/2023
4.1.345	716	12/4/2023
4.1.342	676	12/4/2023
4.1.337	767	12/4/2023
4.1.334	714	11/28/2023
4.1.331	714	11/21/2023
4.1.328	678	11/21/2023
4.1.323	712	11/21/2023
4.1.316	748	11/14/2023
4.1.311	695	11/14/2023
4.1.305	719	11/14/2023
4.1.300	740	11/10/2023
4.1.290	712	11/6/2023
4.1.287	696	11/6/2023
4.1.282	795	10/31/2023
4.1.276	3,065	10/18/2023
4.1.273	759	10/17/2023
4.1.268	716	10/17/2023
4.1.261	924	9/19/2023
4.1.258	812	9/18/2023
4.1.253	1,024	9/5/2023
4.1.250	803	9/5/2023
4.1.241	2,428	8/24/2023
4.1.238	902	8/14/2023
4.1.235	962	8/9/2023
4.1.232	945	8/1/2023
4.1.229	956	8/1/2023
4.1.224	943	8/1/2023
4.1.217	963	7/31/2023
4.1.208	937	7/29/2023
4.1.203	921	7/28/2023
4.1.196	901	7/28/2023
4.1.190	973	7/24/2023
4.1.188	950	7/24/2023
4.1.184	995	7/24/2023
4.1.149	954	7/17/2023
4.1.146	958	7/11/2023
4.1.143	979	7/11/2023
4.1.138	927	7/3/2023
4.1.135	991	6/15/2023
4.1.132	968	6/6/2023
4.1.131	948	6/6/2023
4.1.128	973	6/6/2023
4.1.123	1,641	5/24/2023
4.1.120	972	5/24/2023
4.1.115	965	5/24/2023
4.1.104	908	5/4/2023
4.1.101	953	5/3/2023
4.1.96	1,082	4/9/2023
4.1.92	998	4/4/2023
4.1.87	982	3/25/2023
4.1.79	985	3/23/2023
4.1.76	1,132	3/3/2023
4.1.73	988	3/3/2023
4.1.57	1,002	3/3/2023
4.1.54	1,173	1/24/2023
4.1.53	1,210	1/15/2023
4.1.48	1,058	1/15/2023
4.1.45	1,066	1/14/2023
4.1.40	1,075	1/14/2023
3.2.35	1,052	1/14/2023
3.2.32	1,142	12/25/2022
3.2.27	1,014	12/25/2022
3.2.19	30,528	6/21/2021
3.1.5	11,529	10/23/2020
3.0.40	11,126	4/18/2020
3.0.38	2,033	4/7/2020
3.0.30	1,393	3/30/2020
3.0.23	1,430	3/29/2020
3.0.15	1,407	3/29/2020
3.0.12	1,347	3/29/2020
3.0.9	1,515	3/28/2020
2.0.93	6,845	3/28/2020
2.0.92	1,745	3/28/2020
2.0.89	1,743	3/28/2020
2.0.88	1,758	3/28/2020
2.0.80	1,796	3/28/2020
2.0.64	7,129	12/30/2019
2.0.61	21,310	12/3/2019
2.0.58	2,544	9/22/2019
2.0.48	3,730	2/15/2019
2.0.47	1,929	2/15/2019
1.0.0	1,869	2/15/2019