Skip to content

.NET library for interacting with the excellent Postcodes.io service.

License

Notifications You must be signed in to change notification settings

markembling/MarkEmbling.PostcodesIO

Repository files navigation

MarkEmbling.PostcodesIO

.NET library for interacting with the excellent Postcodes.io service.

Usage

var client = new PostcodesIOClient();
var result = client.Lookup("GU1 1AA");
// result contains properties such as Latitude, Longitude, Region, County and so on...

Check out the integration tests (MarkEmbling.PostcodesIO.Tests) for further examples.

Do not instantiate a new instance of PostocdesIOClient for each request. If you use a dependency-injection container, register the client as a singleton.

Supports .NET Framework 4.7.2 and above, and .NET Standard 2.0 onwards.


This library is still a work-in-progress. More examples and documentation will come soon, along with the missing API methods.

In the meantime, the package is available on NuGet:

PM> Install-Package MarkEmbling.PostcodesIO

Be aware: the API may fluctuate until it hits v1.0. But I think it's already going down the right path, so we're probably fine for the most part. But as always, use at your own risk.

Contributions

Feel free to make contributions via a pull request. Please keep the tests current (and add, if necessary).