Postcode/address finder XML API - user guide
This is a generic user guide to accessing our XML API. The XML API gives access to the RapidAddress and BasicAddress products. Feel free to contact us should you need any help with integration.
Making a request
The lookup server is accessed via HTTP, the base URI is:
pcls1.craftyclicks.co.uk/xml/
Endpoints
Each product has a dedicated endpoint:
| Product | Full URI |
| RapidAddress | pcls1.craftyclicks.co.uk/xml/rapidaddress |
| BasicAddress | pcls1.craftyclicks.co.uk/xml/basicaddress |
Parameters
| Parameter | Required | Description |
| postcode | yes | UK postcde to be looked up, upper or lower case, can have spaces |
| key | yes/no | your access token; required for access to real data, optional only for access to free postcodes |
| response | no | response format: paf_compact (default) or data_formatted |
| lines | no | number of address lines, only applies if response = data_formatted, default is 2, maximum is 3 |
Response format
Best way to see what the response XML looks like is to simply try a few requests in your browser. Here is a few examples of how to format the requests. The 'key' parameter is left out for clarity, the free postcodes are used.
RapidAddress (Full PAF, premise level data):
- rapidaddress?postcode=AA11AA
- rapidaddress?postcode=AA11AB
- rapidaddress?postcode=AA11AB&response=data_formatted
- rapidaddress?postcode=AA11AB&response=data_formatted&lines=3
BasicAddress (Part PAF, street level data):
- basicaddress?postcode=AA11AA
- basicaddress?postcode=AA11AB
- basicaddress?postcode=AA11AB&response=data_formatted
A few bad requests, returning errors:
- basicaddress?postcode=AA11AC (invalid postcode)
- basicaddress?postcode=XXXXXX&key=XXXXX (invalid key)
Protocols available
The XML API is available via SSL as well. Prefix the URI with 'http://' or 'https://' as needed. We recommend using SSL only when necessary, it attracts a performance penalty.
Error codes
| Code | Reason |
| 0001 | Postcode not found |
| 0002 | Invalid postcode format |
| 7001 | Demo limit exceeded |
| 8001 | Invalid or no access token |
| 8003 | Account credit allowance exceeded |
| 8004 | Access denied due to access rules |
| 8005 | Access denied, account suspended |
| 9001 | Internal server error |
Java Script
XML API
Web Service Access
