Ordnance Survey Postcode By Region
Select postcode by district (where district is any of unitary authority, district, metropolitan district, London Borough) or ward.
Example API call:
http://api.kasabi.com/api/ordnance-survey-postcode-region?district=70000...
Postcode as KML:
http://api.kasabi.com/api/ordnance-survey-postcode-region?district=7000000000037256&apikey=yourkey&output=kml
Remember default limit is set so add a &limit=100 (or whatever) on the end to get more...
Table of contents
Endpoint URL
Login to test this query using our experimental API explorer
Authentication
You will need your API key in order to authenticate to this API. You have two options for authentication:
- By URL Parameter -- add a
apikeyparameter to your request URL, with your key as the value - By Request Header -- add a custom HTTP header called
X_KASABI_APIKEYto your HTTP request, with your key as the value
For more information on Kasabi authentication options read the authentication documentation. Your API key will need to be authorized to use this service.
Parameters
This API supports the following request parameters:
| Parameter | Default | Required | Type | Base | Notes |
|---|---|---|---|---|---|
| district | No | uri | http://data.ordnancesurvey.co.uk/id/ | ||
| ward | No | uri | http://data.ordnancesurvey.co.uk/id/ |
HTTP Response Codes
Clients should be prepared to receive any valid HTTP response code. The following table lists the most frequently used codes
| Code | Meaning |
|---|---|
200 OK | Successful Request |
400 Bad Request | Missing or malformed SPARQL query |
401 Not Authorized | API key is not authorized to access the data |
Please also review our additional notes on response codes.
Response Formats
The following response formats are supported for this SPARQL endpoint. Formats can be selected using either the HTTP Accept header, or via the output parameter. As noted in the table below, the type of SPARQL query further limits the available range of output options Please also review our additional notes on content negotiation used in Kasabi APIs
| Name | Media Type | Notes |
|---|---|---|
| kml | application/vnd.google-earth.kml+xml |