{"_id":"55e07605a44fae0d002146d9","githubsync":"","project":"55e06494a44fae0d002146aa","parentDoc":null,"category":{"_id":"55e06997a44fae0d002146c2","pages":["55e069c558c5460d0076aa04","55e069de186ca30d00f9b442","55e06a04186ca30d00f9b444","55e06a1058c5460d0076aa07","55e06a236bad670d0081f256","55e06a4ea44fae0d002146c3","55e06a5c58c5460d0076aa0a","55e06a82186ca30d00f9b446","55e07605a44fae0d002146d9","55e95f48e5d0c623003ed87d","55e95f98e5d0c623003ed880","55e95fb987e942230032e42a","55e970357f564237001d5b75","55e9708b358d923700be9851","55e97096461e2a390050f227","55e970c1461e2a390050f229","565450386cdff93500a8a860"],"project":"55e06494a44fae0d002146aa","version":"55e06495a44fae0d002146ad","__v":17,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T14:00:55.281Z","from_sync":false,"order":6,"slug":"os-places","title":"OS Places"},"user":"55e056b06bad670d0081f234","__v":27,"version":{"_id":"55e06495a44fae0d002146ad","project":"55e06494a44fae0d002146aa","__v":54,"createdAt":"2015-08-28T13:39:33.907Z","releaseDate":"2015-08-28T13:39:33.907Z","categories":["55e06496a44fae0d002146ae","55e06997a44fae0d002146c2","55e06a6958c5460d0076aa0c","55e06ae66bad670d0081f25c","55e06cc1a44fae0d002146cb","55e06ddda44fae0d002146cd","55e95f261fd7e82300ef359f","55e95fe47fc27b2d00d32cfa","55e96eef358d923700be984d","55e96ef6358d923700be984e","55e96efda7ca823900ad547e","55e96f04a7ca823900ad547f","55e970cc358d923700be9853","55e973f4358d923700be9858","55e973f9a7ca823900ad548c","55e977bf358d923700be985d","55e9780f8b72bb3700b1d5bd","55e97815a7ca823900ad5493","55e9781c358d923700be985f","55e97821461e2a390050f23b","55f963c23bb4bb0d0022d18c","5624c67406e8040d005ed6b2","5624dcf25a86b423009462e8","5625f229d0f87e190014c4ed","5627819fe2ce610d004e3ec8","562781b23a4c6b0d00c4556b","5627837166c62617009d17e2","5627851efcbbc621004ebff1","5627860044c87f0d00fe6491","562e3c6d54a5be0d00070c3e","564c955aae6cb82100dc137a","5652e22abbe7110d00dba748","5652f25523d4262d00b21c58","5652fdad51e4e81900bf2452","5652fdcbb60abb1700bafadc","5654494f65bec717007e0293","565da11a77f0090d005818ff","565f063f413e06170093de18","565f06fb413e06170093de21","56dd6773efaca42900e5f58e","56dd68630c3bb41700b0b037","56dd7d24d5419f170075dfb3","56dd9448c117291700015b60","56dd9454c117291700015b61","577a6f8b9748b80e00ef3f45","577a6f969748b80e00ef3f46","577bba7f6e5f301900fada99","57a9cc8e5b1ace0e00de743f","58aab134c50c33250046b8f8","58aab146aecc3e2500573d4c","58aab1628f862f250076f92e","58aab1938f862f250076f92f","58aab3e5aecc3e2500573d56","58aab3f2aecc3e2500573d57"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-28T14:53:57.259Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What does the OS Places API do?\"\n}\n[/block]\nThe OS Places API lets users identify addresses accurately. Searches interrogate the Local Authority and the Royal Mail address datasets. \nRequests can be made using a full or partial address, a postcode, or a unique property ID. Searches can also find addresses closest to a given point or all the addresses known within a user-defined area or circle.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"You can:\",\n  \"body\": \"* Find a specific address accurately\\n* Reverse geocode an address from its location\\n* Search both Royal Mail and Local Authority address datasets\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"You can't:\",\n  \"body\": \"* Find addresses outside the United Kingdom (the data does include Isle of Man and Channel Islands) \\n* Locate general areas such as cities, forests\\n* Carry out bulk matching queries\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How does the API do that?\"\n}\n[/block]\nThis is a RESTful API, returning queries in either XML or JSON. The GeoSearch resources require coordinates in either EPSG:27700, EPSG:4326, EPSG:3857 or EPSG:4258. The find resource enables rapid searches of AddressBase Premium to drill down and isolate ambiguous addressing details. The match resource is for more granular matching and cleansing of existing address databases. Neither features needs any database management of AddressBase Premium. Postcode searches need the area and district integers as a minimum.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"We’ll use our head office postcode as an example – SO16 0AS:\\nSO represents the area\\nSO16 the district\\nSO16 0 the sector\\nSO16 0AS the unit\\n\\nSO16 0AS is the full postcode of our head office in Southampton. But searches for Ordnance Survey at SO16 will return details showing that our address is on Adanac Drive.\",\n  \"title\": \"Postcodes\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"British National Grid (BNG)\",\n  \"body\": \"X coordinates in BNG are also commonly referred to as Eastings, while Y coordinates are also known as Northings.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Which data source(s) does the API use?\"\n}\n[/block]\n###AddressBase Premium\nAddressBase Premium provides the most detailed view of an address and its life cycle. It has more records than other AddressBase products as it provides all the information relating to an address or property from creation to retirement. \nIt contains local authority, Ordnance Survey and Royal Mail® addresses, current addresses, and alternatives for current addresses, provisional addresses (such as planning developments) and historic information, plus OWPAs and cross references to the OS MasterMap® TOIDs®.\n\nAddressBase Premium is made up of -\n* Up to date cross references to our large-scale data, such as OS MasterMap Topography Layer and Integrated Transport Network Layer via the TOID – but also references to objects that don’t have postal addresses, as well as coordinates that have been verified via our surveyors.\n* Data from the Local Land and Property Gazetteer and One Scotland Gazetteer, which includes information captured under statutory obligation through the SNN process.  \n* The Royal Mail’s data, providing a Postcode Address File (PAF) containing the UDPRN and the delivery point address record.\n* The Valuation Office Agency (VOA), which provides cross references to council tax and non-domestic rates data.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Northern Ireland Addresses\",\n  \"body\": \"OS Places contains addresses located within Northern Ireland; however they have a few unique characteristics due to not being derived from Address Base Premium. Addresses within Northern Ireland will not have a UPRN or status, and coordinates will be ‘0.0’ due to falling outside of the British National Grid.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Data Currency\"\n}\n[/block]\nThe underlying data for OS Places is updated every **six weeks**. More information can be found [here](https://apidocs.os.uk/v1.0/docs/os-places-technical-detail).","excerpt":"","slug":"os-places-overview","type":"basic","title":"Overview"}
[block:api-header] { "type": "basic", "title": "What does the OS Places API do?" } [/block] The OS Places API lets users identify addresses accurately. Searches interrogate the Local Authority and the Royal Mail address datasets. Requests can be made using a full or partial address, a postcode, or a unique property ID. Searches can also find addresses closest to a given point or all the addresses known within a user-defined area or circle. [block:callout] { "type": "success", "title": "You can:", "body": "* Find a specific address accurately\n* Reverse geocode an address from its location\n* Search both Royal Mail and Local Authority address datasets" } [/block] [block:callout] { "type": "danger", "title": "You can't:", "body": "* Find addresses outside the United Kingdom (the data does include Isle of Man and Channel Islands) \n* Locate general areas such as cities, forests\n* Carry out bulk matching queries" } [/block] [block:api-header] { "type": "basic", "title": "How does the API do that?" } [/block] This is a RESTful API, returning queries in either XML or JSON. The GeoSearch resources require coordinates in either EPSG:27700, EPSG:4326, EPSG:3857 or EPSG:4258. The find resource enables rapid searches of AddressBase Premium to drill down and isolate ambiguous addressing details. The match resource is for more granular matching and cleansing of existing address databases. Neither features needs any database management of AddressBase Premium. Postcode searches need the area and district integers as a minimum. [block:callout] { "type": "info", "body": "We’ll use our head office postcode as an example – SO16 0AS:\nSO represents the area\nSO16 the district\nSO16 0 the sector\nSO16 0AS the unit\n\nSO16 0AS is the full postcode of our head office in Southampton. But searches for Ordnance Survey at SO16 will return details showing that our address is on Adanac Drive.", "title": "Postcodes" } [/block] [block:callout] { "type": "info", "title": "British National Grid (BNG)", "body": "X coordinates in BNG are also commonly referred to as Eastings, while Y coordinates are also known as Northings." } [/block] [block:api-header] { "type": "basic", "title": "Which data source(s) does the API use?" } [/block] ###AddressBase Premium AddressBase Premium provides the most detailed view of an address and its life cycle. It has more records than other AddressBase products as it provides all the information relating to an address or property from creation to retirement. It contains local authority, Ordnance Survey and Royal Mail® addresses, current addresses, and alternatives for current addresses, provisional addresses (such as planning developments) and historic information, plus OWPAs and cross references to the OS MasterMap® TOIDs®. AddressBase Premium is made up of - * Up to date cross references to our large-scale data, such as OS MasterMap Topography Layer and Integrated Transport Network Layer via the TOID – but also references to objects that don’t have postal addresses, as well as coordinates that have been verified via our surveyors. * Data from the Local Land and Property Gazetteer and One Scotland Gazetteer, which includes information captured under statutory obligation through the SNN process. * The Royal Mail’s data, providing a Postcode Address File (PAF) containing the UDPRN and the delivery point address record. * The Valuation Office Agency (VOA), which provides cross references to council tax and non-domestic rates data. [block:callout] { "type": "info", "title": "Northern Ireland Addresses", "body": "OS Places contains addresses located within Northern Ireland; however they have a few unique characteristics due to not being derived from Address Base Premium. Addresses within Northern Ireland will not have a UPRN or status, and coordinates will be ‘0.0’ due to falling outside of the British National Grid." } [/block] [block:api-header] { "type": "basic", "title": "Data Currency" } [/block] The underlying data for OS Places is updated every **six weeks**. More information can be found [here](https://apidocs.os.uk/v1.0/docs/os-places-technical-detail).