{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/addresses/postcode?","auth":"required","settings":"55e96024e5d0c623003ed884","examples":{"codes":[{"name":"","code":"var req = new XMLHttpRequest();\nreq.open(\"GET\", \"https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16&key=[[app:key]]\",true);\n\nreq.onreadystatechange = function () {\n console.log(req.responseText);\n}\nreq.send();","language":"javascript"},{"code":"var url = 'https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16&key=[[app:key]]';\n\n$.getJSON(url, function(data){\n console.log(data);\n})","language":"javascript","name":"JQuery"},{"code":"var https = require('https');\n\nhttps.get(\"https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16&key=[[app:key]]\", function(res) {\n console.log(\"Got response: \" + res.statusCode);\n res.on('data', function(d) {\n process.stdout.write(d);\n });\n}).on('error', function(e) {\n console.log(\"Got error: \" + e.message);\n});","language":"javascript","name":"Node.js"},{"code":"<?php\n\t\t$curl = curl_init();\n curl_setopt ($curl, CURLOPT_URL, \"https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16&key=[[app:key]]\");\n curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);\n\n $result = curl_exec ($curl);\n curl_close ($curl);\n print \"<pre>$result\";\n?>","language":"php","name":"PHP"},{"code":"<html lang=\"en\" ng-app=\"angularAPI\">\n<head>\n <meta charset=\"utf-8\">\n <script src=\"https://ajax.googleapis.com/ajax/libs/angularjs/1.4.9/angular.min.js\"></script>\n</head>\n\n<script type=\"text/javascript\">\n\tvar osAPI = angular.module('angularAPI', []);\n\n\tosAPI.controller('apiService', ['$scope', '$http', function($scope, $http) {\n\t\tvar key = \"[[app:key]]\";\n\t\tvar query = 'https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16';\n\t\t$http.get(query+'&key='+key).success(function(data) {\n\t\t\t$scope.output = data.results;\n\t\t});\n\t}]);\n</script>\n\n<body ng-controller=\"apiService\">\n\t<ul ng-repeat=\"value in output\">\n\t\t<li ng-repeat=\"object in value\">\n\t\t\t<p>{{object}}</p>\n\t\t</li>\n\t</ul>\n</body>\n</html>","language":"html","name":"AngularJS"}]},"method":"get","params":[{"name":"postcode","type":"string","default":"","desc":"Postcode search parameter.","required":true,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35ae"},{"name":"format","type":"string","default":"JSON, XML","desc":"The format in which the response will be returned. Default: JSON","required":false,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35ad"},{"name":"maxresults","type":"int","default":"1-100","desc":"The maximum number of results to return. Default: 100","required":false,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35ac"},{"name":"offset","type":"int","default":"","desc":"Offset the list of returned by this amount.","required":false,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35ab"},{"name":"dataset","type":"string","default":"DPA, LPI","desc":"The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA","required":false,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35aa"},{"name":"lr","type":"string","default":"EN, CY","desc":"Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY","required":false,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35a9"},{"name":"fq","type":"string","default":"classification_code:[code], LOGICAL_STATUS_CODE:[code]","desc":"A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code separating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 .","required":false,"in":"query","ref":"","_id":"55e9640c1fd7e82300ef35a8"},{"name":"output_srs","type":"string","default":"BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258","desc":"The intended output spatial reference system. Default: EPSG:27700","required":false,"in":"query","ref":"","_id":"56ab546dd4432d1900eed163"}],"results":{"codes":[{"language":"json","code":"{\n \"header\" : {\n \"uri\" : \"https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16&maxresults=1\",\n \"query\" : \"postcode=SO16\",\n \"offset\" : 0,\n \"totalresults\" : 28722,\n \"format\" : \"JSON\",\n \"dataset\" : \"DPA\",\n \"lr\" : \"EN,CY\",\n \"maxresults\" : 1,\n \"epoch\" : \"37\",\n \"output_srs\" : \"EPSG:27700\"\n },\n \"results\" : [ {\n \"DPA\" : {\n \"UPRN\" : \"100062510110\",\n \"ADDRESS\" : \"48 ROWNHAMS PARK, UPPER TOOTHILL ROAD, ROWNHAMS, SOUTHAMPTON, SO16 8AL\",\n \"BUILDING_NAME\" : \"48 ROWNHAMS PARK\",\n \"THOROUGHFARE_NAME\" : \"UPPER TOOTHILL ROAD\",\n \"DEPENDENT_LOCALITY\" : \"ROWNHAMS\",\n \"POST_TOWN\" : \"SOUTHAMPTON\",\n \"POSTCODE\" : \"SO16 8AL\",\n \"RPC\" : \"1\",\n \"X_COORDINATE\" : 438267.0,\n \"Y_COORDINATE\" : 117639.0,\n \"STATUS\" : \"APPROVED\",\n \"LOGICAL_STATUS_CODE\" : \"1\",\n \"CLASSIFICATION_CODE\" : \"RD\",\n \"CLASSIFICATION_CODE_DESCRIPTION\" : \"Dwelling\",\n \"LOCAL_CUSTODIAN_CODE\" : 1760,\n \"LOCAL_CUSTODIAN_CODE_DESCRIPTION\" : \"TEST VALLEY\",\n \"POSTAL_ADDRESS_CODE\" : \"S\",\n \"POSTAL_ADDRESS_CODE_DESCRIPTION\" : \"A single address\",\n \"BLPU_STATE_CODE\" : \"2\",\n \"BLPU_STATE_CODE_DESCRIPTION\" : \"In use\",\n \"TOPOGRAPHY_LAYER_TOID\" : \"osgb1000002109163325\",\n \"PARENT_UPRN\" : \"200010014955\",\n \"LAST_UPDATE_DATE\" : \"01/12/2007\",\n \"ENTRY_DATE\" : \"05/05/2001\",\n \"BLPU_STATE_DATE\" : \"19/02/2009\",\n \"LANGUAGE\" : \"EN\",\n \"MATCH\" : 1.0,\n \"MATCH_DESCRIPTION\" : \"EXACT\"\n }\n } ]\n}","name":"OK - JSON","status":200},{"status":200,"language":"xml","code":"<AddressAPI>\n\t<header>\n\t\t<uri>\nhttps://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?postcode=SO16&maxresults=1&format=xml\n\t\t</uri>\n\t\t<query>postcode=SO16</query>\n\t\t<offset>0</offset>\n\t\t<totalresults>28722</totalresults>\n\t\t<format>xml</format>\n\t\t<dataset>DPA</dataset>\n\t\t<lr>EN,CY</lr>\n\t\t<maxresults>1</maxresults>\n\t\t<epoch>37</epoch>\n <output_srs>EPSG:27700</output_srs>\n\t</header>\n\t<results>\n\t\t<DPA>\n\t\t\t<UPRN>100062510110</UPRN>\n\t\t\t<ADDRESS>\n48 ROWNHAMS PARK, UPPER TOOTHILL ROAD, ROWNHAMS, SOUTHAMPTON, SO16 8AL\n\t\t\t</ADDRESS>\n\t\t\t<BUILDING_NAME>48 ROWNHAMS PARK</BUILDING_NAME>\n\t\t\t<THOROUGHFARE_NAME>UPPER TOOTHILL ROAD</THOROUGHFARE_NAME>\n\t\t\t<DEPENDENT_LOCALITY>ROWNHAMS</DEPENDENT_LOCALITY>\n\t\t\t<POST_TOWN>SOUTHAMPTON</POST_TOWN>\n\t\t\t<POSTCODE>SO16 8AL</POSTCODE>\n\t\t\t<RPC>1</RPC>\n\t\t\t<X_COORDINATE>438267.0</X_COORDINATE>\n\t\t\t<Y_COORDINATE>117639.0</Y_COORDINATE>\n\t\t\t<STATUS>APPROVED</STATUS>\n\t\t\t<LOGICAL_STATUS_CODE>1</LOGICAL_STATUS_CODE>\n\t\t\t<CLASSIFICATION_CODE>RD</CLASSIFICATION_CODE>\n\t\t\t<CLASSIFICATION_CODE_DESCRIPTION>Dwelling</CLASSIFICATION_CODE_DESCRIPTION>\n\t\t\t<LOCAL_CUSTODIAN_CODE>1760</LOCAL_CUSTODIAN_CODE>\n\t\t\t<LOCAL_CUSTODIAN_CODE_DESCRIPTION>TEST VALLEY</LOCAL_CUSTODIAN_CODE_DESCRIPTION>\n\t\t\t<POSTAL_ADDRESS_CODE>S</POSTAL_ADDRESS_CODE>\n\t\t\t<POSTAL_ADDRESS_CODE_DESCRIPTION>A single address</POSTAL_ADDRESS_CODE_DESCRIPTION>\n\t\t\t<BLPU_STATE_CODE>2</BLPU_STATE_CODE>\n\t\t\t<BLPU_STATE_CODE_DESCRIPTION>In use</BLPU_STATE_CODE_DESCRIPTION>\n\t\t\t<TOPOGRAPHY_LAYER_TOID>osgb1000002109163325</TOPOGRAPHY_LAYER_TOID>\n\t\t\t<PARENT_UPRN>200010014955</PARENT_UPRN>\n\t\t\t<LAST_UPDATE_DATE>01/12/2007</LAST_UPDATE_DATE>\n\t\t\t<ENTRY_DATE>05/05/2001</ENTRY_DATE>\n\t\t\t<BLPU_STATE_DATE>19/02/2009</BLPU_STATE_DATE>\n\t\t\t<LANGUAGE>EN</LANGUAGE>\n\t\t\t<MATCH>1.0</MATCH>\n\t\t\t<MATCH_DESCRIPTION>EXACT</MATCH_DESCRIPTION>\n\t\t</DPA>\n\t</results>\n</AddressAPI>","name":"OK - XML"},{"code":"// Example: Missing mandatory parameter\n{\n \"error\" : {\n \"statuscode\" : 400,\n \"message\" : \"No postcode parameter provided.\"\n }\n}\n\n// Example: Parameter entry of wrong type\n{\n \"error\" : {\n \"statuscode\" : 400,\n \"message\" : \"Parameter maxresults contains invalid characters. Valid characters are numeric.\"\n }\n}\n\n// Example: Wrong parameter name\n{\n \"error\" : {\n \"statuscode\" : 400,\n \"message\" : \"Parameter x is not a valid parameter for resource postcode. Valid parameters for requested resource are postcode, format, dataset, maxresults, offset, lr, fq.\"\n }\n}","status":400,"language":"json"},{"status":401,"language":"json","code":"{\n \"fault\": {\n \"faultstring\": \"Invalid ApiKey\",\n \"detail\": {\n \"errorcode\": \"oauth.v2.InvalidApiKey\"\n }\n }\n}"},{"language":"json","code":"{\n \"error\": {\n \"statuscode\": \"404\",\n \"message\": \"Resource x does not exist. Valid resources are match, find, uprn, postcode, nearest, bbox, radius.\"\n }\n}","status":404},{"code":"{ \n \"fault\":{ \n \"faultstring\":\"Received 405 Response without Allow Header\",\n \"detail\":{ \n \"errorcode\":\"protocol.http.Response405WithoutAllowHeader\"\n }\n }\n}","status":405,"language":"json"},{"status":500,"language":"json","code":"{\n \"error\": {\n \"statuscode\": 500,\n \"message\": \"The provided request resulted in an internal server error.\"\n }\n}"}]}},"next":{"description":"","pages":[]},"title":"Postcode","type":"endpoint","slug":"os-places-postcode","excerpt":"OS Places Postcode","body":"","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55e069de186ca30d00f9b442","project":"55e06494a44fae0d002146aa","__v":2,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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"],"_id":"55e06495a44fae0d002146ad","releaseDate":"2015-08-28T13:39:33.907Z","createdAt":"2015-08-28T13:39:33.907Z","project":"55e06494a44fae0d002146aa","__v":54},"createdAt":"2015-08-28T14:02:06.552Z","editedParams":true,"parentDoc":null,"user":"55e056b06bad670d0081f234","category":{"sync":{"isSync":false,"url":""},"pages":["55ed65182e66b62100994163"],"title":"endpoint","slug":"endpoint","order":8,"from_sync":false,"reference":true,"_id":"55e95fe47fc27b2d00d32cfa","version":"55e06495a44fae0d002146ad","createdAt":"2015-09-04T09:09:56.318Z","project":"55e06494a44fae0d002146aa","__v":1},"editedParams2":true,"githubsync":""}getPostcode
OS Places Postcode
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
postcode:
required
string
Postcode search parameter.
format:
stringJSON, XML
The format in which the response will be returned. Default: JSON
maxresults:
integer1-100
The maximum number of results to return. Default: 100
offset:
integer
Offset the list of returned by this amount.
dataset:
stringDPA, LPI
The dataset to return. Multiple values can be sent, separated by a comma. Default: DPA
lr:
stringEN, CY
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY
fq:
stringclassification_code:[code], LOGICAL_STATUS_CODE:[code]
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code separating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 .
output_srs:
stringBNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258
The intended output spatial reference system. Default: EPSG:27700
