Address lookup API

Postcoder provides the fastest, most reliable way to capture accurate addresses.

Postcode to address lookup

Lookup UK addresses using postcodes, and Irish addresses using Eircodes.

Uses the latest PAF and Multiple Residence data from Royal Mail, and ECAD data from Eircode.

Example code

Node JS Example PHP Example Javascript Example jQuery Example iOS Swift Example C# Example

Request URL

UK postcode lookup

GET | https://ws.postcoder.com/pcw/[apikey]/address/uk/[postcode-or-address-fragment]

Irish Eircode lookup

GET | https://ws.postcoder.com/pcw/[apikey]/address/ie/[eircode-or-address-fragment]

Try it now

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
postcodeonly	Limits the request to a postcode-only search rather than matching the search term on other parts of an address	true, false	false
alias	Includes aliases for addresses known to and accepted by Royal Mail	true, false	false
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

Response fields for postal addresses

We recommend you use the following fields for a UK or Irish postal address:

UK	Ireland
addressline1	addressline1
addressline2	addressline2
posttown	posttown
postcode	county
	postcode

Response fields

Field	Description	Example	Returned by default?
summaryline	A string containing the entire address	Allies Computing Ltd, Manor Farm Barns, Fox Road, Framingham Pigot, Norwich, Norfolk, NR14 7PZ	Yes
addressline`[n]`	Contains the `[n]`th line of the address for printing on a label. Won't contain posttown, postcode, or any fields excluded with `?exclude=`	Allies Computing Ltd	Use ?lines=`[n]` to set number of required address lines
pobox	PO Box number, if present		Yes
organisation	Organisation name at that address, if present	Allies Computing Ltd	Yes
departmentname	Department name		Yes
buildingname	Building name	Manor Farm Barns	Yes
subbuildingname	Sub-building name		Yes
number	House/Flat number	8	Yes
premise	Name of the premise	Manor Farm Barns	Yes
dependentstreet	Name of a dependent street if it is present in the address		Yes
street	Street name	Fox Road	Yes
doubledependentlocality	Name of the double dependant locality, if it is present in the address	Eagle Road Industrial Estate	Yes
dependentlocality	Name of the dependent locality, if it is present in the address	Framingham Pigot	Yes
posttown	Posttown name. Always present in UK addresses	Norwich	Yes
county	County name	Norfolk	Yes
postcode	Postcode. Always present in UK addresses	NR14 7PZ	Yes
notyetbuilt	Boolean value that displays if an address is a part of the "Not Yet Built" dataset from Royal Mail	true	Use ?nyb=true
recodes	Colon separated list of the previous postcode, previous delivery point suffix and the date it changed (YYYYMM format)	CM7 8PX:1A:200112	Yes
morevalues	Indicates at least one more page of addresses for the lookup	true	Yes
nextpage	Page number for the next page of results	2	Yes
totalresults	Total number of results for the lookup	458	Yes
longitude	The longitude associated with the result	1.3491603533	Use ?addtags=longitude
latitude	The latitude associated with the result	52.5859730797	Use ?addtags=latitude
uniquedeliverypointreferencenumber	Unique Delivery Point Refernce Number (UDPRN) - a unique number applied by Royal Mail to every UK delivery point	17448021	Use ?addtags=udprn
alias	Indicates if an address is an alias record.	true	Use ?alias=true

Predictive address autocomplete

Autocomplete UK addresses and Irish addresses with predictive as-you-type suggestions.

Uses the latest PAF and Multiple Residence data from Royal Mail, and ECAD data from Eircode.

Example code

Javascript Example

Step 1: Request URL - Return as-you-type suggestions

GET | https://ws.postcoder.com/pcw/autocomplete/find ?query=[first-letters-of-address] &country=[country] &apikey=[apikey]

Step 1: Querystring parameters

Parameter	Description	Required	Values
query	The search term (minimum of three characters required, returns empty array otherwise)	Yes	E.g. 1 birchwood h
pathfilter	Allows you to narrow down the search using the ID of a suggestion that was not an address from a previous request (i.e. where the type was not "ADD")	No	E.g. UK@STATE\\|Suffolk@CTY\\|{Rushmere St. Andrew@LOC,Ipswich@PTN,IP@PCDA}@LOC\|{Birchwood Drive@STR,IP5-1EB@PCD}@PCD
country	The 2 letter ISO 3166-1 country code	Yes	UK or IE
apikey	The API key	Yes	E.g. PCW45-12345-12345-1234X
format	The response format; default is JSON unless an application/xml header is detected	No	json or xml
maximumresults	The maximum number of results to return; default is 30	No	5 - 30

Tip

If you're having issues with Chrome's autofill blocking your suggestions, use the autocomplete="xyz" attribute in your input tag. Chrome ignores the autocomplete="off" attribute.

Step 1: Response fields

Field	Description	Example	Returned by default?
id	The ID of the address or place	52752859	Yes
type	The type of suggestion; see definitions below	ADD	Yes
summaryline	The summary of the address or place	1 Birchwood Hall Cottages	Yes
locationsummary	The location associated with the address or place	Chathill, Northumberland, NE67 5LG	Yes
count	The number of further suggestions nested within the suggestion	66	Yes

Definitions for the 'type' response field

Name	Description
ADD	Address
BGN	Building group
BNA	Building name
CCN	County
DST	Dependent street
LAD	District borough
LOC	Place
LOC2	Dependent place
LOC3	Double dependent place
NUM	Number
ORC	Organisation
ORD	Department
PCD	Postcode
PCDA	Postcode area
PCDD	Postcode district
PCDS	Postcode sector
PCDU1	Postcode unit 1
POB	PO Box
SBN	Sub building name
STATE	State
STR	Street
WORLD	World

Step 2: Request URL - Return a full address

GET | https://ws.postcoder.com/pcw/autocomplete/retrieve ?id=[id-from-step-one] &query=[query-from-step-one] &country=[country] &apikey=[apikey]

Step 2: Querystring parameters

Parameter	Description	Required	Values
id	The ID of a suggestion that was an address from a previous request (i.e. where the type was 'ADD')	Yes	6219058
query	The original search term	Yes	E.g. 1 birchwood h
country	The 2 letter ISO 3166-1 country code	Yes	UK or IE
apikey	The API key	Yes	E.g. PCW45-12345-12345-1234X
format	The response format; default is JSON unless an application/xml header is detected	No	json or xml
identifier	Identify your lookup to make debugging and reviewing stats easier	No	E.g. myform
lines	The number of lines over which to split the address	No	0, 1, 2, 3, 4
include	Include extra address fields within the address lines returned	No	county, posttown, postcode
exclude	Exclude address fields within the address lines returned	No	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Add extra address fields such as UDPRN to the return	No	See Additional data fields
callback	Use to specify the name of your JSONP callback function	No

Step 2: Response fields

Field	Description	Example	Returned by default?
summaryline	A string containing the entire address	Allies Computing Ltd, Manor Farm Barns, Fox Road, Framingham Pigot, Norwich, Norfolk, NR14 7PZ	Yes
addressline`[n]`	Contains the `[n]`th line of the address for printing on a label. Won't contain posttown, postcode, or any fields excluded with `?exclude=`	Allies Computing Ltd	Use ?lines=`[n]` to set number of required address lines
pobox	PO Box number, if present		Yes
organisation	Organisation name at that address, if present	Allies Computing Ltd	Yes
departmentname	Department name		Yes
buildingname	Building name	Manor Farm Barns	Yes
subbuildingname	Sub-building name		Yes
number	House/Flat number	8	Yes
premise	Name of the premise	Manor Farm Barns	Yes
dependentstreet	Name of a dependent street if it is present in the address		Yes
street	Street name	Fox Road	Yes
doubledependentlocality	Name of the double dependant locality, if it is present in the address	Eagle Road Industrial Estate	Yes
dependentlocality	Name of the dependent locality, if it is present in the address	Framingham Pigot	Yes
posttown	Posttown name. Always present in UK addresses	Norwich	Yes
county	County name	Norfolk	Yes
postcode	Postcode. Always present in UK addresses	NR14 7PZ	Yes
notyetbuilt	Boolean value that displays if an address is a part of the "Not Yet Built" dataset from Royal Mail	true	Use ?nyb=true
recodes	Colon separated list of the previous postcode, previous delivery point suffix and the date it changed (YYYYMM format)	CM7 8PX:1A:200112	Yes
morevalues	Indicates at least one more page of addresses for the lookup	true	Yes
nextpage	Page number for the next page of results	2	Yes
totalresults	Total number of results for the lookup	458	Yes
longitude	The longitude associated with the result	1.3491603533	Use ?addtags=longitude
latitude	The latitude associated with the result	52.5859730797	Use ?addtags=latitude
alias	Indicates if an address is an alias record.	true	Use ?alias=true

Examples

Show suggestions for "1 birchwood h"

https://ws.postcoder.com/pcw/autocomplete/find ?query=1%20birchwood%20h &country=UK &apikey=PCW45-12345-12345-1234X &format=json

[
	{
		"id": "16291869",
		"type": "ADD",
		"summaryline": "1 Birchwood Hall Cottages",
		"locationsummary": "Chathill, Northumberland, NE67 5LG",
		"count": 1
	},
	...
	{
		"id": "UK@STATE|Greater London@CTY|London@LOC|Hackney@LAD|{Woodberry Grove@STR,N4@PCDD}@STR|{N4-1FR@PCD,Birchwood Apartments@BNA,Flat 1-66@RNG}@PCD",
		"type": "PCD",
		"summaryline": "Flat 1-66, Birchwood Apartments, N4 1FR",
		"locationsummary": "Woodberry Grove, London, Hackney",
		"count": 66
	}
]

Expand the "Flat 1-66, Birchwood Apartments, N4 1FR" suggestion found above

https://ws.postcoder.com/pcw/autocomplete/find ?query=1%20birchwood%20h &pathfilter=UK@STATE|Greater%20London@CTY|London@LOC|Hackney@LAD|{Woodberry%20Grove@STR,N4@PCDD}@STR|{N4-1FR@PCD,Birchwood%20Apartments@BNA,Flat%201-66@RNG}@PCD &country=UK &apikey=PCW45-12345-12345-1234X &format=json

[
	{
		"id": "52752859",
		"type": "ADD",
		"summaryline": "Flat 1",
		"locationsummary": "Birchwood Apartments, Woodberry Grove, London, Hackney, N4 1FR",
		"count": 1
	},
	...
	{
		"id": "52752397",
		"type": "ADD",
		"summaryline": "Flat 64",
		"locationsummary": "Birchwood Apartments, Woodberry Grove, London, Hackney, N4 1FR",
		count: 1
	}
]

Retrieve full address for the "Flat 1, Birchwood Apartments" suggestion found above

https://ws.postcoder.com/pcw/autocomplete/retrieve ?id=52752859 &query=1%20birchwood%20h &country=UK &apikey=PCW45-12345-12345-1234X &format=json &lines=2

[
	{
		"addressline1": "Flat 1, Birchwood Apartments",
		"addressline2": "Woodberry Grove",
		"summaryline": "Flat 1, Birchwood Apartments, Woodberry Grove, London, Greater London, N4 1FR",
		"subbuildingname": "Flat 1",
		"buildingname": "Birchwood Apartments",
		"premise": "Flat 1, Birchwood Apartments",
		"street": "Woodberry Grove",
		"posttown": "London",
		"county": "Greater London",
		"postcode": "N4 1FR"
	}
]

Additional data fields

Include additional fields by appending ?addtags=[comma-delimited-addtags-field-names] to your request URL.

Address data
Coordinates
Census data
NHS data
Government data

Address data

Description	Addtags field name	Tag name returned in output
Delivery Point Suffix	deliverypointsuffix	deliverypointsuffix
Unique Delivery Point Reference Number (UDPRN)	udprn	uniquedeliverypointreferencenumber
Multiple Occupancy Count - count of the number of multiple occupancy addresses for the delivery point	multipleoccupancycount	multipleoccupancycount
Administrative County (top tier local government)	administrativecounty	administrativecounty
Former Postal County	postalcounty	postalcounty
Traditional County	traditionalcounty	traditionalcounty
User Category (residential 'R', Non-residential 'N', or Large 'L')	usercategory	usercategory
Sortcode (for Royal Mail Mailsort)	sortcode	sortcode
Country code (within the United Kingdom)	countrycode	countrycode
Country name (within the United Kingdom)	country	country
Welsh language alternative for dependent street field	welsh_dependentstreet	welsh_dependentstreet
Welsh language alternative for street field	welsh_street	welsh_street
Welsh language alternative for double dependent locality field	welsh_doubledependentlocality	welsh_doubledependentlocality
Welsh language alternative for dependent locality field	welsh_dependentlocality	welsh_dependentlocality
Welsh language alternative for post town field	welsh_posttown	welsh_posttown

Coordinates

Description	Addtags field name	Tag name returned in output
Easting OS Grid Reference (1m precision in units of 1m)	grideast1metre	grideasting
Northing OS Grid Reference (1m precision in units of 1m)	gridnorth1metre	gridnorthing
Latitude (OSGB36)	latitudeosgb36	latitudeosgb
Longitude (OSGB36)	longitudeosgb36	longitudeosgb
Latitude (ETRS89)	latitudeetrs89	latitude
Longitude (ETRS89)	longitudeetrs89	longitude

Census data

Description	Addtags field name	Tag name returned in output
2011 Census Output Area	oa11	oa11
2011 Census Lower Layer Super Output Area	lsoa11	lsoa11
2011 Census Middle Layer Super Output Area	msoa11	msoa11
2001 Census Output Area	censusoutputarea_2001	censusoutputarea_2001
2001 Census Lower Layer Super Output Area	censuslowerlayersuperoutputarea_2001	censuslowerlayersuperoutputarea_2001
2001 Census Middle Layer Super Output Area	censusmiddlelayersuperoutputarea_2001	censusmiddlelayersuperoutputarea_2001
2001 Census Area Statistics (CAS) Ward	censusareastatisticswardcode	censusareastatisticswardcode
2005 Statistical Ward	statisticalwardcode_2005	statisticalwardcode_2005

NHS data

Description	Addtags field name	Tag name returned in output
NHS Commissioning Region Code (ONS GSS)	commissioningregioncode_gss	commissioningregioncode_gss
NHS Commissioning Region Name	commissioningregionname	commissioningregionname
NHS Area Team Code (NHS)	areateamcode_nhs	areateamcode_nhs
NHS Area Team Code (ONS GSS)	areateamcode_gss	areateamcode_gss
NHS Area Team Name	areateamname	areateamname
NHS Clinical Commissioning Group Code (NHS)	clinicalcommissioninggroupcode_nhs	clinicalcommissioninggroupcode_nhs
NHS Clinical Commissioning Group Code (ONS GSS)	clinicalcommissioninggroupcode_gss	clinicalcommissioninggroupcode_gss
NHS Clinical Commissioning Group Name	clinicalcommissioninggroupname	clinicalcommissioninggroupname

Government data

Description	Addtags field name	Tag name returned in output
Local Authority Ward Code	localauthoritywardcode	localauthoritywardcode
Local Authority Code	localauthoritycode	localauthoritycode
Local Authority Name	localauthorityname	localauthorityname
Electoral Ward Code	electoralwardcode	electoralwardcode
Electoral Ward Name	electoralwardname	electoralwardname
Electoral County Code	electoralcountycode	electoralcountycode
Electoral County Name	electoralcountyname	electoralcountyname
Parish Code	parishcode	parishcode
Westminster Parliamentary Constituency Code	parliamentaryconstituencycode	parliamentaryconstituencycode
Westminster Parliamentary Constituency Name	parliamentaryconstituencyname	parliamentaryconstituencyname
European Electoral Region Code	europeanelectoralregioncode	europeanelectoralregioncode
European Electoral Region Name	europeanelectoralregionname	europeanelectoralregionname
National Park Name	nationalparkname	nationalparkname
National Park Code	nationalparkcode	nationalparkcode

International address lookup

Lookup international addresses using the first address line and / or postal code.

Request URL

GET | http://ws.postcoder.com/pcw/[apikey]/address/[country-code]/[address-fragment]

Example

http://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/address/us/1600%20PENNSYLVANIA,%2020500-0001 ?format=json &identifier=mytestlookup &lines=4

[
	{
		"addressline1": "PRESIDENT",
		"addressline2": "1600 PENNSYLVANIA AVE NW",
		"addressline3": "WASHINGTON DC  20500-0001",
		"addressline4": "UNITED STATES",
		"summaryline": "PRESIDENT, 1600 PENNSYLVANIA AVE NW, WASHINGTON DC  20500-0001, UNITED STATES",
		"organisation": "PRESIDENT",
		"number": "1600",
		"premise": "1600",
		"street": "PENNSYLVANIA AVE NW",
		"posttown": "WASHINGTON",
		"state": "DISTRICT OF COLUMBIA",
		"stateabbreviation": "DC",
		"postcode": "20500-0001",
		"country": "UNITED STATES"
	}
]

Supported countries and country codes

Country	Buildings	Streets	Towns	Country Code
Afghanistan			✔	AF
Aland Islands	✔	✔	✔	AX
Albania		✔	✔	AL
Algeria		✔	✔	DZ
American Samoa	✔	✔	✔	AS
Andorra	✔	✔	✔	AD
Angola		✔	✔	AO
Anguilla		✔	✔	AI
Antarctica			✔	AQ
Antigua and Barbuda		✔	✔	AG
Argentina	✔	✔	✔	AR
Armenia		✔	✔	AM
Aruba		✔	✔	AW
Australia	✔	✔	✔	AU
Austria	✔	✔	✔	AT
Azerbaijan	✔	✔	✔	AZ
Bahamas	✔	✔	✔	BS
Bahrain	✔	✔	✔	BH
Bangladesh		✔	✔	BD
Barbados		✔	✔	BB
Belarus		✔	✔	BY
Belgium	✔	✔	✔	BE
Belize		✔	✔	BZ
Benin		✔	✔	BJ
Bermuda		✔	✔	BM
Bhutan		✔	✔	BT
Bolivia		✔	✔	BO
Bonaire, Sint Eustatius And Saba			✔	BQ
Bosnia and Herzegovina	✔	✔	✔	BA
Botswana	✔	✔	✔	BW
Br. Indian Ocean Ter.			✔	IO
Brazil	✔	✔	✔	BR
Brunei Darussalam	✔	✔	✔	BN
Bulgaria	✔	✔	✔	BG
Burkina Faso		✔	✔	BF
Burundi		✔	✔	BI
Cambodia		✔	✔	KH
Cameroon		✔	✔	CM
Canada	✔	✔	✔	CA
Cape Verde		✔	✔	CV
Cayman Islands	✔	✔	✔	KY
Central African Rep.		✔	✔	CF
Chad		✔	✔	TD
Chile	✔	✔	✔	CL
China		✔	✔	CN
Christmas Island			✔	CX
Cocos (Keeling) Islands			✔	CC
Colombia	✔	✔	✔	CO
Comoros		✔	✔	KM
Congo (Dem. Rep.)		✔	✔	CD
Congo (Rep.)		✔	✔	CG
Cook Islands		✔	✔	CK
Costa Rica	✔	✔	✔	CR
Côte d'Ivoire			✔	CI
Croatia	✔	✔	✔	HR
Cuba		✔	✔	CU
Curacao		✔	✔	CW
Cyprus	✔	✔	✔	CY
Czech Republic	✔	✔	✔	CZ
Denmark	✔	✔	✔	DK
Djibouti		✔	✔	DJ
Dominica		✔	✔	DM
Dominican Republic		✔	✔	DO
Ecuador	✔	✔	✔	EC
Egypt	✔	✔	✔	EG
El Salvador		✔	✔	SV
Equatorial Guinea		✔	✔	GQ
Eritrea		✔	✔	ER
Estonia	✔	✔	✔	EE
Ethiopia		✔	✔	ET
Falkland Is. (Malvinas)		✔	✔	FK
Faröe Islands		✔	✔	FO
Fiji		✔	✔	FJ
Finland	✔	✔	✔	FI
France	✔	✔	✔	FR
French Guiana	✔	✔	✔	GF
French Polynesia		✔	✔	PF
French Southern Territories			✔	TF
Gabon		✔	✔	GA
Gambia		✔	✔	GM
Georgia		✔	✔	GE
Germany	✔	✔	✔	DE
Ghana		✔	✔	GH
Gibraltar	✔	✔	✔	GI
Greece	✔	✔	✔	GR
Greenland		✔	✔	GL
Grenada		✔	✔	GD
Guadeloupe	✔	✔	✔	GP
Guam	✔	✔	✔	GU
Guatemala		✔	✔	GT
Guinea		✔	✔	GN
Guinea-Bissau		✔	✔	GW
Guyana		✔	✔	GY
Haiti		✔	✔	HT
Honduras		✔	✔	HN
Hong Kong	✔	✔	✔	HK
Hungary	✔	✔	✔	HU
Iceland	✔	✔	✔	IS
India	✔	✔	✔	IN
Indonesia	✔	✔	✔	ID
Iran			✔	IR
Iraq		✔	✔	IQ
Ireland	✔	✔	✔	IE
Israel	✔	✔	✔	IL
Italy	✔	✔	✔	IT
Jamaica		✔	✔	JM
Japan	✔	✔	✔	JP
Jordan	✔	✔	✔	JO
Kazakhstan	✔	✔	✔	KZ
Kenya		✔	✔	KE
Kiribati		✔	✔	KI
Korea (Dem. Rep.)			✔	KP
Korea (Rep.)	✔	✔	✔	KR
Kuwait	✔	✔	✔	KW
Kyrgyzstan		✔	✔	KG
Laos			✔	LA
Latvia	✔	✔	✔	LV
Lebanon	✔	✔	✔	LB
Lesotho	✔	✔	✔	LS
Liberia		✔	✔	LR
Libya		✔	✔	LY
Liechtenstein	✔	✔	✔	LI
Lithuania	✔	✔	✔	LT
Luxembourg	✔	✔	✔	LU
Macao	✔	✔	✔	MO
Macedonia, TFYR	✔	✔	✔	MK
Madagascar		✔	✔	MG
Malawi		✔	✔	MW
Malaysia	✔	✔	✔	MY
Maldives		✔	✔	MV
Mali		✔	✔	ML
Malta	✔	✔	✔	MT
Marshall Islands	✔	✔	✔	MH
Martinique	✔	✔	✔	MQ
Mauritania		✔	✔	MR
Mauritius		✔	✔	MU
Mayotte		✔	✔	YT
Mexico	✔	✔	✔	MX
Micronesia	✔	✔	✔	FM
Moldova		✔	✔	MD
Monaco	✔	✔	✔	MC
Mongolia		✔	✔	MN
Montenegro	✔	✔	✔	ME
Montserrat		✔	✔	MS
Morocco	✔	✔	✔	MA
Mozambique		✔	✔	MZ
Myanmar		✔	✔	MM
Namibia	✔	✔	✔	NA
Nauru			✔	NR
Nepal		✔	✔	NP
Netherlands	✔	✔	✔	NL
New Caledonia		✔	✔	NC
New Zealand	✔	✔	✔	NZ
Nicaragua		✔	✔	NI
Niger		✔	✔	NE
Nigeria		✔	✔	NG
Niue		✔	✔	NU
Norfolk Island		✔	✔	NF
Northern Mariana Islands	✔	✔	✔	MP
Norway	✔	✔	✔	NO
Oman	✔	✔	✔	OM
Pakistan			✔	PK
Palau	✔	✔	✔	PW
Palestinian Territory			✔	PS
Panama	✔	✔	✔	PA
Papua New Guinea		✔	✔	PG
Paraguay	✔	✔	✔	PY
Peru	✔	✔	✔	PE
Philippines	✔	✔	✔	PH
Pitcairn			✔	PN
Poland	✔	✔	✔	PL
Portugal	✔	✔	✔	PT
Puerto Rico	✔	✔	✔	PR
Qatar	✔	✔	✔	QA
Réunion	✔	✔	✔	RE
Romania	✔	✔	✔	RO
Russia	✔	✔	✔	RU
Rwanda		✔	✔	RW
S. Georgia and S. Sandwich			✔	GS
Saint Helena		✔	✔	SH
Saint Lucia		✔	✔	LC
Saint Martin		✔	✔	MF
Saint Pierre and Miquelon		✔	✔	PM
Saint-Barthélemy	✔	✔	✔	BL
Samoa		✔	✔	WS
San Marino	✔	✔	✔	SM
Sao Tomé and Principe		✔	✔	ST
Saudi Arabia	✔	✔	✔	SA
Senegal		✔	✔	SN
Serbia	✔	✔	✔	RS
Seychelles		✔	✔	SC
Sierra Leone		✔	✔	SL
Singapore	✔	✔	✔	SG
Sint Maarten		✔	✔	SX
Slovakia	✔	✔	✔	SK
Slovenia	✔	✔	✔	SI
Solomon Islands		✔	✔	SB
Somalia		✔	✔	SO
South Africa	✔	✔	✔	ZA
South Sudan		✔	✔	SS
Spain	✔	✔	✔	ES
Sri Lanka		✔	✔	LK
St. Kitts and Nevis		✔	✔	KN
St. Vincent and Grenadines		✔	✔	VC
Sudan			✔	SD
Suriname	✔	✔	✔	SR
Svalbard and Jan Mayen		✔	✔	SJ
Swaziland		✔	✔	SZ
Sweden	✔	✔	✔	SE
Switzerland	✔	✔	✔	CH
Syria			✔	SY
Taiwan	✔	✔	✔	TW
Tajikistan		✔	✔	TJ
Tanzania		✔	✔	TZ
Thailand	✔	✔	✔	TH
Timor-Leste			✔	TL
Togo		✔	✔	TG
Tokelau		✔	✔	TK
Tonga		✔	✔	TO
Trinidad and Tobago		✔	✔	TT
Tunisia	✔	✔	✔	TN
Turkey	✔	✔	✔	TR
Turkmenistan		✔	✔	TM
Turks and Caicos Is.		✔	✔	TC
Tuvalu		✔	✔	TV
Uganda		✔	✔	UG
Ukraine	✔	✔	✔	UA
United Arab Emirates	✔	✔	✔	AE
United Kingdom	✔	✔	✔	GB
United States Minor Outlying Islands			✔	UM
United States of America	✔	✔	✔	US
United States Virgin Islands	✔	✔	✔	VI
Uruguay	✔	✔	✔	UY
Uzbekistan		✔	✔	UZ
Vanuatu		✔	✔	VU
Vatican City		✔	✔	VA
Venezuela		✔	✔	VE
Viet Nam	✔	✔	✔	VN
Virgin Islands, British		✔	✔	VG
Wallis and Futuna		✔	✔	WF
Western Sahara			✔	EH
Yemen			✔	YE
Zambia		✔	✔	ZM
Zimbabwe	✔	✔	✔	ZW

DPA lookup using AddressBase Premium

Lookup Delivery Point Address (DPA) records using a postcode or part of an address.

Uses the latest AddressBase Premium data from OS.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/addressbase/dpa/[postcode-or-address-fragment]

Examples

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/dpa/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=uprn

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/dpa/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=addressbase

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

UPRN lookup using AddressBase Premium

Lookup a record using a UPRN.

Uses the latest AddressBase Premium data from OS.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/addressbase/uprn/[uprns-comma-delimited]

Examples

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/uprn/2630163102 ?format=json &identifier=mytestlookup &lines=2 &addtags=uprn

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/uprn/2630163102 ?format=json &identifier=mytestlookup &lines=2 &addtags=addressbase

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function

LPI lookup using AddressBase Premium

Lookup Local Property Identifier (LPI) records using a postcode or part of an address.

LPI records are not postal addresses but relate to geographic features.

Uses the latest AddressBase Premium data from OS.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/addressbase/lpi/[postcode-or-address-fragment]

Examples

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/lpi/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=uprn

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/lpi/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=addressbase

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

DPA and LPI lookup using AddressBase Premium

Lookup Delivery Point Address (DPA) and / or Local Property Identifier (LPI) records using a postcode or part of an address.

Uses the latest AddressBase Premium data from OS.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/addressbase/dpalpi/[postcode-or-address-fragment]

Examples

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/dpalpi/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=uprn

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/addressbase/dpalpi/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=addressbase

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

PAF lookup enriched with AddressBase Premium

Lookup addresses in PAF using a postcode or part of an address, and return additional information with AddressBase Premium.

Uses the latest PAF and Multiple Residence data from Royal Mail, and AddressBase Premium data from OS.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/pafaddressbase/[postcode-or-address-fragment]

Examples

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/pafaddressbase/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=uprn

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/pafaddressbase/NR14%207PZ ?format=json &identifier=mytestlookup &lines=2 &addtags=addressbase

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

Irish address lookup using Eircode

Lookup Irish addresses using an Eircode or part of an address.

Uses the latest ECAD data from Eircode.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/address/ie/[eircode-or-address-fragment]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/address/ie/D02X285 ?format=json &identifier=mytestlookup &lines=2 &addtags=latitude,longitude

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

Irish geocoding using Eircode

Lookup coordinates for an Eircode in Ireland.

Uses the latest ECAD data from Eircode.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/position/ie/[eircode]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/position/ie/D02X28 ?format=json &identifier=mytestlookup

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
callback	Sets the name of your JSONP callback function

Irish reverse geocoding using Eircode

Lookup Irish addresses using latitude and longitude.

Uses the latest ECAD data from Eircode.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/rgeo/ie/[latitude]/[longitude]?distance=[distance-in-metres]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/rgeo/ie/53.332067/-6.255492 ?distance=50 &format=json &identifier=mytestlookup

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
callback	Sets the name of your JSONP callback function

Not Yet Built lookup

Lookup under-construction and not-yet-built addresses using a postcode or part of an address.

Uses the latest Not Yet Built data from Royal Mail.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/nyb/uk/[postcode-or-address-fragment]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/nyb/uk/NR147P ?format=json &identifier=mytestlookup &lines=2

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0

UK geocoding

Lookup coordinates for a postcode in the UK.

Uses the latest data from the Office for National Statistics.

Example code

Node JS Example PHP Example Javascript Example jQuery Example C# Example

Request URL

Postcode to geodata

GET | https://ws.postcoder.com/pcw/[apikey]/position/uk/[postcode]

Full address with geodata

GET | https://ws.postcoder.com/pcw/[apikey]/address/uk/[postcode-or-address-fragment]?addtags=latitude,longitude

Try it now

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
callback	Sets the name of your JSONP callback function

UK reverse geocoding

Lookup street addresses in the UK using latitude and longitude.

Uses the latest data from Royal Mail and the Office for National Statistics.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/rgeo/uk/[latitude]/[longitude]?distance=[distance-in-metres]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/rgeo/uk/52.5859714116/1.3492192897 ?distance=50 &format=json &identifier=mytestlookup

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
callback	Sets the name of your JSONP callback function

UK street lookup

Lookup the UK street(s) for a postcode.

Uses the latest PAF and Multiple Residence data from Royal Mail.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/street/uk/[postcode]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/street/uk/NR147P ?format=json &identifier=mytestlookup

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
callback	Sets the name of your JSONP callback function

UDPRN lookup

Lookup a UK address using a UDPRN.

Uses the latest PAF and Multiple Residence data from Royal Mail.

Request URL

GET | https://ws.postcoder.com/pcw/[apikey]/udprn/[udprn]

Example

https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/udprn/1744802 ?format=json &identifier=mytestlookup &lines=2

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list	See Additional data fields
callback	Sets the name of your JSONP callback function

Optional querystring parameters

Parameter	Description	Values	Default
format	Sets the data format of the response; the default is json unless header of application/xml is detected	xml, json	json
identifier	Sets an identifier like "checkout" or "contactform" to help you group requests within your search history
lines	Sets the number of address lines over which to display the first part of each address in the response	0, 1, 2, 3, 4	0
include	Specifies the extra address fields to include within the address lines, using a comma-delimited list	county, posttown, postcode
exclude	Specifies the address fields to exclude within the address lines, using a comma-delimited list	pobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtags	Specifies the extra address fields to include within the response, using a comma-delimited list
postcodeonly	Limits the request to a postcode-only search rather than matching the search term on other parts of an address	true, false	false
alias	Includes aliases for addresses known to and accepted by Royal Mail	true, false	false
callback	Sets the name of your JSONP callback function
page	Specifies the page of results to return where 0 is the first page	0, 1, 2, 3...	0