street

This endpoint returns one or more street addresses for a given UK postcode.

Request URL

GET https://ws.postcoder.com/pcw/{apikey}/street/uk/{postcode}

Path parameters

Parameter	Description	Example
`apikey`	Your API key	`PCW45-12345-12345-1234X`
`postcode`	The URL-encoded UK postcode that you wish to look up	`nr1%201ne`

Querystring parameters

Parameter	Description	Example
`format`	Sets the format of the response, xml or json (default unless "application/xml" header is detected)	`format=json`
`identifier`	Specifies your own meaningful identifier for the request such as "websiteA" or "client123"; you can view usage for each identifier on the Identifier Usage page, which may be helpful when using your API key across multiple websites, apps or clients	`identifier=websiteA`
`addtags`	Specifies the extra address fields to include within the response using a comma-delimited list, supported values: latitude, longitude, udprn, deliverypointsuffix, usercategory... see additional response fields below for the full list	`addtags=latitude,longitude`
`callback`	Specifies the name of your JSONP callback function	`callback=jsoncallback`

Example request and response

Return UK streets with a postcode of NR1 1NE:

GET https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/street/uk/nr1%201ne?format=json

[
	{
		"summaryline": "St. Faiths Lane, Norwich, Norfolk, NR1 1NE",
		"street": "St. Faiths Lane",
		"posttown": "Norwich",
		"county": "Norfolk",
		"postcode": "NR1 1NE"
	}
]

Response fields

Field	Description	Example
`summaryline`	A summary of the street, ideal for displaying in a drop-down list	St. Faiths Lane, Norwich, Norfolk, NR1 1NE
`dependentstreet`	The dependent street
`street`	The street	St. Faiths Lane
`doubledependentlocality`	The double dependent locality
`dependentlocality`	The dependent locality
`posttown`	The post town	Norwich
`county`	The county	Norfolk
`postcode`	The postcode	NR1 1NE

Additional response fields

These additional fields can be included in the response by using the addtags querystring parameter to specify a comma-delimited list of field names.

Example: addtags=latitude,longitude,udprn,deliverypointsuffix,usercategory

Field	Description	Querystring parameter to use
Coordinate data
`latitude`	Latitude (ETRS89)	`addtags=latitude`
`longitude`	Longitude (ETRS89)	`addtags=longitude`
`latitudeosgb`	Latitude (OSGB36)	`addtags=latitudeosgb36`
`longitudeosgb`	Longitude (OSGB36)	`addtags=longitudeosgb36`
`grideasting`	Easting OS Grid Reference (1m precision in units of 1m)	`addtags=grideast1metre`
`gridnorthing`	Northing OS Grid Reference (1m precision in units of 1m)	`addtags=gridnorth1metre`
Address fields
`deliverypointsuffix`	Delivery Point Suffix	`addtags=deliverypointsuffix`
`uniquedeliverypointreferencenumber`	Unique Delivery Point Reference Number (UDPRN)	`addtags=udprn`
`multipleoccupancycount`	Multiple Occupancy Count - count of the number of multiple occupancy addresses for the delivery point	`addtags=multipleoccupancycount`
`administrativecounty`	Administrative County (top tier local government)	`addtags=administrativecounty`
`postalcounty`	Former Postal County	`addtags=postalcounty`
`traditionalcounty`	Traditional County	`addtags=traditionalcounty`
`usercategory`	User Category (residential 'R', Non-residential 'N', or Large 'L')	`addtags=usercategory`
`sortcode`	Sortcode for Royal Mail Mailsort	`addtags=sortcode`
`countrycode`	Country code (within the United Kingdom)	`addtags=countrycode`
`country`	Country name (within the United Kingdom)	`addtags=country`
`welsh_dependentstreet`	Welsh language alternative for dependent street field	`addtags=welsh_dependentstreet`
`welsh_street`	Welsh language alternative for street field	`addtags=welsh_street`
`welsh_doubledependentlocality`	Welsh language alternative for double dependent locality field	`addtags=welsh_doubledependentlocality`
`welsh_dependentlocality`	Welsh language alternative for dependent locality field	`addtags=welsh_dependentlocality`
`welsh_posttown`	Welsh language alternative for post town field	`addtags=welsh_posttown`
Census data
`oa11`	2011 Census Output Area	`addtags=oa11`
`lsoa11`	2011 Census Lower Layer Super Output Area	`addtags=lsoa11`
`msoa11`	2011 Census Middle Layer Super Output Area	`addtags=msoa11`
`censusoutputarea_2001`	2001 Census Output Area	`addtags=censusoutputarea_2001`
`censuslowerlayersuperoutputarea_2001`	2001 Census Lower Layer Super Output Area	`addtags=censuslowerlayersuperoutputarea_2001`
`censusmiddlelayersuperoutputarea_2001`	2001 Census Middle Layer Super Output Area	`addtags=censusmiddlelayersuperoutputarea_2001`
`censusareastatisticswardcode`	2001 Census Area Statistics (CAS) Ward	`addtags=censusareastatisticswardcode`
`statisticalwardcode_2005`	2005 Statistical Ward	`addtags=statisticalwardcode_2005`
NHS data
`commissioningregioncode_gss`	NHS Commissioning Region Code (ONS GSS)	`addtags=commissioningregioncode_gss`
`commissioningregionname`	NHS Commissioning Region Name	`addtags=commissioningregionname`
`areateamcode_nhs`	NHS Area Team Code (NHS)	`addtags=areateamcode_nhs`
`areateamcode_gss`	NHS Area Team Code (ONS GSS)	`addtags=areateamcode_gss`
`areateamname`	NHS Area Team Name	`addtags=areateamname`
`clinicalcommissioninggroupcode_nhs`	NHS Clinical Commissioning Group Code (NHS)	`addtags=clinicalcommissioninggroupcode_nhs`
`clinicalcommissioninggroupcode_gss`	NHS Clinical Commissioning Group Code (ONS GSS)	`addtags=clinicalcommissioninggroupcode_gss`
`clinicalcommissioninggroupname`	NHS Clinical Commissioning Group Name	`addtags=clinicalcommissioninggroupname`
Government data
`localauthoritywardcode`	Local Authority Ward Code	`addtags=localauthoritywardcode`
`localauthoritycode`	Local Authority Code	`addtags=localauthoritycode`
`localauthorityname`	Local Authority Name	`addtags=localauthorityname`
`electoralwardcode`	Electoral Ward Code	`addtags=electoralwardcode`
`electoralwardname`	Electoral Ward Name	`addtags=electoralwardname`
`electoralcountycode`	Electoral County Code	`addtags=electoralcountycode`
`electoralcountyname`	Electoral County Name	`addtags=electoralcountyname`
`parishcode`	Parish Code	`addtags=parishcode`
`parliamentaryconstituencycode`	Westminster Parliamentary Constituency Code	`addtags=parliamentaryconstituencycode`
`parliamentaryconstituencyname`	Westminster Parliamentary Constituency Name	`addtags=parliamentaryconstituencyname`
`europeanelectoralregioncode`	European Electoral Region Code	`addtags=europeanelectoralregioncode`
`europeanelectoralregionname`	European Electoral Region Name	`addtags=europeanelectoralregionname`
`nationalparkname`	National Park Name	`addtags=nationalparkname`
`nationalparkcode`	National Park Code	`addtags=nationalparkcode`

Integration advice

URL encode all special characters (including /) in your request parameters with %xx encoding
When using your API key across multiple websites, apps or clients, set the identifier querystring parameter to a meaningful value such as "websiteA" or "client123"; you'll then be able to view these identifiers and the number of requests made by each one on the Identifier Usage page
Treat all response fields as optional

Credit cost

Each request costs the following number of credits:

Standard request	Enhanced request using `addtags`
1.5 credits	1.9 credits

Buy a credit pack or set up a monthly plan to use with all Postcoder endpoints.