GET Postcode/Postcodes/{postCode}

Retrieves a list of valid UK postcodes that start with the provided prefix.

Request Information

URI Parameters

Name	Description	Type	Additional information
postCode	The postcode prefix to search against.	string	Required

Body Parameters

None.

Response Information

Resource Description

A collection of postcodes.

Collection of string

Response Formats

HTTP response status code: 200

application/json, text/json

Sample:

[
  "SW1 2AB",
  "E11 8JK"
]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>SW1 2AB</string>
  <string>E11 8JK</string>
</ArrayOfstring>

HTTP response status code: 403

When the user has submitted too many requests, no further requests should be made until after 5 minutes

text/plain

Sample:

Body:

<html><head><title>Forbidden - Contracts Finder</title></head><body><p><h1><strong>Request forbidden</strong></h1></p><p>The request rate limit may have been exceeded. If you believe this is an error <a href="https://www.contractsfinder.service.gov.uk/Home/Contact">contact us</a> quoting 0QrFmYQAAAABs5RRpp9L8RbtJ8k4jz8gwTE9OMjFFREdFMDIwOABiYTEyMjkxMi0zZWE0LTQ1NTQtYjNjNi1mNmRmZDU2MGY2ZDM=.</p></body></html>