Skip to content

andymccall/api.postcode.software

Repository files navigation

Postcode.software

Query for UK postcodes over HTTP and HTTPS. Postcode.software uses the Post Office sample PAF file.

Documentation for the API can be found at Swagger.

Build Status and Test Coverage

Build Status Coverage Status

A demo of this service can be found at:

http://api.postcode.software/ & https://api.postcode.software/

Currently working API endpoints are:

* ping
* postcode/<postcode>
* postcode/<postcode>/<building_no>
* validate/<postcode>
* validate/<postcode>/<building_no>
* random
* random/<number_of_random_records_to_return>
* udprn/<udprn>

The service uses the sample PAF file from the Post Office which does not have all addresses in it, to test use /random or /random/<number_of_random_records_to_return> to return valid postcodes.

Releases

No releases published

Packages

No packages published

Languages