A Sinatra app that takes a UK address string and attempts to parse it into its constituent parts.
Addresses are hard, we should know! So we've built this handy app to help you navigate around this thorny issue.
Simply POST your address string like so (using curl):
curl --data "address=10 Downing Street, London, SW1A 2AA" http://sorting-office.openaddressesuk.org/address
If you'd like to submit the address you're using to the OpenAddresses project, then set contribute=true like so:
curl --data "address=10 Downing Street, London, SW1A 2AA&contribute=true" http://sorting-office.openaddressesuk.org/address
If you choose to take this option then you must comply with our submission guidelines.
You'd get the following response in JSON format:
{
"saon": null,
"paon": "10",
"street": {
"name": "Downing Street",
"url": "http://alpha.openaddressesuk.org/streets/PXxwpD"
}
"locality": null,
"town": {
"name": "London",
"url": "https://alpha.openaddressesuk.org/towns/4194LO"
}
"postcode": {
"name": "SW1A 2AA",
"url": "https://alpha.openaddressesuk.org/postcodes/EMCYvD"
}
"provenance": {
"activity": {
"executed_at": "2015-01-21T16:18:32+00:00",
"processing_scripts": "https://github.com/OpenAddressesUK/sorting_office",
"derived_from": [
{
"type": "userInput",
"input": "10 Downing Street, London, SW1A 2AA",
"inputted_at": "2015-01-21T16:18:32+00:00",
"processing_script": "https://github.com/OpenAddressesUK/sorting_office/tree/7dd23cb19709680646a20dddfeb18b53ea4346e2/lib/sorting_office/address.rb"
},
{
"type": "Source",
"urls": [
"http://alpha.openaddressesuk.org/postcodes/Uxm2vc"
],
"downloaded_at": "2015-01-21T16:18:32+00:00",
"processing_script": "https://github.com/OpenAddressesUK/sorting_office/tree/7dd23cb19709680646a20dddfeb18b53ea4346e2/lib/models/postcode.rb"
},
{
"type": "Source",
"urls": [
"http://alpha.openaddressesuk.org/towns/qyHZe2"
],
"downloaded_at": "2015-01-21T16:18:32+00:00",
"processing_script": "https://github.com/OpenAddressesUK/sorting_office/tree/7dd23cb19709680646a20dddfeb18b53ea4346e2/lib/models/town.rb"
},
{
"type": "Source",
"urls": [
"http://alpha.openaddressesuk.org/streets/Gq5142"
],
"downloaded_at": "2015-01-21T16:18:32+00:00",
"processing_script": "https://github.com/OpenAddressesUK/sorting_office/tree/7dd23cb19709680646a20dddfeb18b53ea4346e2/lib/models/street.rb"
}
]
}
}
}
If you’d rather not see the provenance data, you can add noprov=true to your request, like so:
curl --data "address=10 Downing Street, London, SW1A 2AA&noprov=true" https://sorting-office.openaddressesuk.org/address
It's that simple!
The only caveat is that you must provide a valid postcode with your request, otherwise the service won't be able to calculate the other address parts. If a postcode is missing or invalid, the service will return a 400 error code and the following JSON:
{
"error": "We couldn't detect a real postcode in your address. Please resubmit with a valid postcode."
}
The address format returned in the JSON closely mirrors the BS7666 standard for addresses. It contains the following fields where name is the name of the resource, and url is the Open Addresses URL for that resource:
saon: The Secondary Addressable Object - this is usually something like a flat number or any other sub unitpaon: The Primary Addressable Object - this is usually a house number or a building namestreet: The street where the building office resideslocality: Sometimes, an address is associated with a locality, which identifies the address with a smaller geographical area than the Post Town (see below).town: This is the Post Town where the address is located. This usually corresponds to the sorting office that handles the mail for the address, as may take in many smaller towns, urban districts and villages (see locality). This is always returned.postcode: This is the Postcode for the address. Currently a postcode is needed for Sorting Office to begin parsing the address, and is always returned.
We are considering how to evolve this format to suit the needs of our roadmap. You can comment on this feature here: OpenAddressesUK/roadmap#66
We know that there are lots of edge cases with addresses, and we know that we might not have caught 100% of them. If there's anything you notice, please let us know, or better still open a pull request to fix it!.
If you haven't already, install the external dependencies below
Clone the repo:
git clone [email protected]:OpenAddressesUK/sorting_office.git
Bundle:
bundle install
Run the bootstrap script:
bundle exec rake bootstrap
This will download and import a copy of the locality, street, postcode and town databases, and run the Elasticsearch indexes, which may take some time. Why not make a cup of tea?
Spin up the server
bundle exec rackup
The server will now be running at http://localhost:9292
To run the standard test suite, simply run:
bundle exec rake
We have another set of tests, which we know don't all pass. This takes some of the edge cases detailed in the Falsehoods programmers believe about addresses blog post, as well as some of the others we've encountered on our travels, and tries to parse them all correctly. If you're interested in helping out, getting some of these tests to pass would be amazing! To run these tests, simply run
rspec spec/big_old_list_spec.rb
And watch the fail! Currently there are 8 failing tests out of 25 in total.
We do not want to receive any names in the submission, other than any company name that may form part of the address. The Open Addresses data that we publish will be about locations, not about people.
Do not worry about the format of the address. The platform is designed and built to support many different formats.
Please be sure not to violate others' intellectual property or privacy rights with your submission. If you think your Intellectual Property rights are being infringed then please report the infringement.
Find out more about our privacy policy.
By submitting an address you are saying that Open Addresses Limited can re-use the address and publish it under an open data licence. You are saying that the publication of the address by Open Addresses Limited or third parties does not and will not infringe any of your legal rights or those of any third party.