{"_id":"55e95fb987e942230032e42a","user":"55c9b7b4e4927a0d0004a727","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"},"__v":7,"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"},"parentDoc":null,"project":"55e06494a44fae0d002146aa","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-04T09:09:13.528Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Endpoint: /places/v1/addresses\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Resource method\",\n    \"0-0\": \"Find\",\n    \"1-0\": \"Postcode\",\n    \"2-0\": \"UPRN\",\n    \"3-0\": \"Match\",\n    \"4-0\": \"Nearest\",\n    \"h-2\": \"Resource url\",\n    \"0-1\": \"GET\",\n    \"1-1\": \"GET\",\n    \"2-1\": \"GET\",\n    \"3-1\": \"GET\",\n    \"4-1\": \"GET\",\n    \"0-2\": \"/find\",\n    \"1-2\": \"/postcode\",\n    \"2-2\": \"/uprn\",\n    \"3-2\": \"/match\",\n    \"4-2\": \"/nearest\",\n    \"6-0\": \"Radius\",\n    \"6-1\": \"GET\",\n    \"6-2\": \"/radius\",\n    \"5-0\": \"Bounding Box\",\n    \"5-1\": \"GET\",\n    \"5-2\": \"/bbox\",\n    \"h-3\": \"Resource description\",\n    \"0-3\": \"Quicker than match and less accurate, a free text search designed for quick use e.g. form filling.\",\n    \"1-3\": \"A search based on a properties postcode. The minimum for the resource is the area and district e.g. SO16, and will accept a full postcode consisting of the area, district, sector and unit e.g. SO16 0AS .\",\n    \"2-3\": \"A search that takes a UPRN as the search parameter.\",\n    \"3-3\": \"A granular, free text search, designed for matching and cleansing existing addresses.\",\n    \"4-3\": \"Takes a pair of coordinates (X and Y) as an input to determine the closest address.\",\n    \"5-3\": \"Takes two points and creates a bounding box around the points. All addresses in this bounding box are then returned.\",\n    \"6-3\": \"Takes a pair of coordinates as the centre for a circle, and returns all address attributes that are intersected by the resulting circle.\",\n    \"h-4\": \"Product Category\",\n    \"0-4\": \"Capture and Verification\",\n    \"1-4\": \"Capture and Verification\",\n    \"2-4\": \"Capture and Verification\",\n    \"3-4\": \"Matching and Cleansing\",\n    \"4-4\": \"GeoSearch\",\n    \"5-4\": \"GeoSearch\",\n    \"6-4\": \"GeoSearch\",\n    \"7-0\": \"Polygon\",\n    \"7-1\": \"POST\",\n    \"7-2\": \"/polygon\",\n    \"7-3\": \"Takes a geoJSON polygon or multi-polygon object and returns all address attributes that are in the object.\",\n    \"7-4\": \"GeoSearch\"\n  },\n  \"cols\": 5,\n  \"rows\": 8\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Northern Ireland\",\n  \"body\": \"Due to Northern Ireland addresses being outside of the British National Grid, the Nearest, BBox and Radius resources are not available for addresses in Northern Ireland.\"\n}\n[/block]","excerpt":"","slug":"os-places-endpoints","type":"basic","title":"Resources"}
[block:api-header] { "type": "basic", "title": "Endpoint: /places/v1/addresses" } [/block] [block:parameters] { "data": { "h-0": "Resource", "h-1": "Resource method", "0-0": "Find", "1-0": "Postcode", "2-0": "UPRN", "3-0": "Match", "4-0": "Nearest", "h-2": "Resource url", "0-1": "GET", "1-1": "GET", "2-1": "GET", "3-1": "GET", "4-1": "GET", "0-2": "/find", "1-2": "/postcode", "2-2": "/uprn", "3-2": "/match", "4-2": "/nearest", "6-0": "Radius", "6-1": "GET", "6-2": "/radius", "5-0": "Bounding Box", "5-1": "GET", "5-2": "/bbox", "h-3": "Resource description", "0-3": "Quicker than match and less accurate, a free text search designed for quick use e.g. form filling.", "1-3": "A search based on a properties postcode. The minimum for the resource is the area and district e.g. SO16, and will accept a full postcode consisting of the area, district, sector and unit e.g. SO16 0AS .", "2-3": "A search that takes a UPRN as the search parameter.", "3-3": "A granular, free text search, designed for matching and cleansing existing addresses.", "4-3": "Takes a pair of coordinates (X and Y) as an input to determine the closest address.", "5-3": "Takes two points and creates a bounding box around the points. All addresses in this bounding box are then returned.", "6-3": "Takes a pair of coordinates as the centre for a circle, and returns all address attributes that are intersected by the resulting circle.", "h-4": "Product Category", "0-4": "Capture and Verification", "1-4": "Capture and Verification", "2-4": "Capture and Verification", "3-4": "Matching and Cleansing", "4-4": "GeoSearch", "5-4": "GeoSearch", "6-4": "GeoSearch", "7-0": "Polygon", "7-1": "POST", "7-2": "/polygon", "7-3": "Takes a geoJSON polygon or multi-polygon object and returns all address attributes that are in the object.", "7-4": "GeoSearch" }, "cols": 5, "rows": 8 } [/block] [block:callout] { "type": "info", "title": "Northern Ireland", "body": "Due to Northern Ireland addresses being outside of the British National Grid, the Nearest, BBox and Radius resources are not available for addresses in Northern Ireland." } [/block]