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

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
postcodeonlyLimits the request to a postcode-only search rather than matching the search term on other parts of an addresstrue, falsefalse
aliasIncludes aliases for addresses known to and accepted by Royal Mailtrue, falsefalse
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 1, 2, 3...0

Response fields for postal addresses

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

UKIreland
addressline1addressline1
addressline2addressline2
posttownposttown
postcodecounty
 postcode

Response fields

FieldDescriptionExampleReturned by default?
summarylineA string containing the entire addressAllies Computing Ltd, Manor Farm Barns, Fox Road, Framingham Pigot, Norwich, Norfolk, NR14 7PZYes
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 LtdUse ?lines=[n] to set number of required address lines
poboxPO Box number, if present Yes
organisationOrganisation name at that address, if presentAllies Computing LtdYes
departmentnameDepartment nameYes
buildingnameBuilding nameManor Farm BarnsYes
subbuildingnameSub-building nameYes
numberHouse/Flat number8Yes
premiseName of the premiseManor Farm BarnsYes
dependentstreetName of a dependent street if it is present in the addressYes
streetStreet nameFox RoadYes
doubledependentlocalityName of the double dependant locality, if it is present in the addressEagle Road Industrial EstateYes
dependentlocalityName of the dependent locality, if it is present in the addressFramingham PigotYes
posttownPosttown name. Always present in UK addressesNorwichYes
countyCounty nameNorfolkYes
postcodePostcode. Always present in UK addressesNR14 7PZYes
notyetbuiltBoolean value that displays if an address is a part of the "Not Yet Built" dataset from Royal MailtrueUse ?nyb=true
recodesColon separated list of the previous postcode, previous delivery point suffix and the date it changed (YYYYMM format)CM7 8PX:1A:200112Yes
morevaluesIndicates at least one more page of addresses for the lookuptrueYes
nextpagePage number for the next page of results2Yes
totalresultsTotal number of results for the lookup458Yes
longitudeThe longitude associated with the result1.3491603533Use ?addtags=longitude
latitudeThe latitude associated with the result52.5859730797Use ?addtags=latitude
uniquedeliverypointreferencenumberUnique Delivery Point Refernce Number (UDPRN) - a unique number applied by Royal Mail to every UK delivery point17448021Use ?addtags=udprn
aliasIndicates if an address is an alias record.trueUse ?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

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

ParameterDescriptionRequiredValues
queryThe search term (minimum of three characters required, returns empty array otherwise)YesE.g. 1 birchwood h
pathfilterAllows 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")NoE.g. UK@STATE\|Suffolk@CTY\|{Rushmere St. Andrew@LOC,Ipswich@PTN,IP@PCDA}@LOC|{Birchwood Drive@STR,IP5-1EB@PCD}@PCD
countryThe 2 letter ISO 3166-1 country codeYesUK or IE
apikeyThe API keyYesE.g. PCW45-12345-12345-1234X
formatThe response format; default is JSON unless an application/xml header is detectedNojson or xml
maximumresultsThe maximum number of results to return; default is 30No5 - 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

FieldDescriptionExampleReturned by default?
idThe ID of the address or place52752859Yes
typeThe type of suggestion; see definitions belowADDYes
summarylineThe summary of the address or place1 Birchwood Hall CottagesYes
locationsummaryThe location associated with the address or placeChathill, Northumberland, NE67 5LGYes
countThe number of further suggestions nested within the suggestion66Yes

Definitions for the 'type' response field

NameDescription
ADDAddress
BGNBuilding group
BNABuilding name
CCNCounty
DSTDependent street
LADDistrict borough
LOCPlace
LOC2Dependent place
LOC3Double dependent place
NUMNumber
ORCOrganisation
ORDDepartment
PCDPostcode
PCDAPostcode area
PCDDPostcode district
PCDSPostcode sector
PCDU1Postcode unit 1
POBPO Box
SBNSub building name
STATEState
STRStreet
WORLDWorld

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

ParameterDescriptionRequiredValues
idThe ID of a suggestion that was an address from a previous request (i.e. where the type was 'ADD')Yes6219058
queryThe original search termYesE.g. 1 birchwood h
countryThe 2 letter ISO 3166-1 country codeYesUK or IE
apikeyThe API keyYesE.g. PCW45-12345-12345-1234X
formatThe response format; default is JSON unless an application/xml header is detectedNojson or xml
identifierIdentify your lookup to make debugging and reviewing stats easierNoE.g. myform
linesThe number of lines over which to split the addressNo0, 1, 2, 3, 4
includeInclude extra address fields within the address lines returnedNocounty, posttown, postcode
excludeExclude address fields within the address lines returnedNopobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsAdd extra address fields such as UDPRN to the returnNoSee Additional data fields
callbackUse to specify the name of your JSONP callback functionNo

Step 2: Response fields

FieldDescriptionExampleReturned by default?
summarylineA string containing the entire addressAllies Computing Ltd, Manor Farm Barns, Fox Road, Framingham Pigot, Norwich, Norfolk, NR14 7PZYes
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 LtdUse ?lines=[n] to set number of required address lines
poboxPO Box number, if present Yes
organisationOrganisation name at that address, if presentAllies Computing LtdYes
departmentnameDepartment nameYes
buildingnameBuilding nameManor Farm BarnsYes
subbuildingnameSub-building nameYes
numberHouse/Flat number8Yes
premiseName of the premiseManor Farm BarnsYes
dependentstreetName of a dependent street if it is present in the addressYes
streetStreet nameFox RoadYes
doubledependentlocalityName of the double dependant locality, if it is present in the addressEagle Road Industrial EstateYes
dependentlocalityName of the dependent locality, if it is present in the addressFramingham PigotYes
posttownPosttown name. Always present in UK addressesNorwichYes
countyCounty nameNorfolkYes
postcodePostcode. Always present in UK addressesNR14 7PZYes
notyetbuiltBoolean value that displays if an address is a part of the "Not Yet Built" dataset from Royal MailtrueUse ?nyb=true
recodesColon separated list of the previous postcode, previous delivery point suffix and the date it changed (YYYYMM format)CM7 8PX:1A:200112Yes
morevaluesIndicates at least one more page of addresses for the lookuptrueYes
nextpagePage number for the next page of results2Yes
totalresultsTotal number of results for the lookup458Yes
longitudeThe longitude associated with the result1.3491603533Use ?addtags=longitude
latitudeThe latitude associated with the result52.5859730797Use ?addtags=latitude
aliasIndicates if an address is an alias record.trueUse ?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

DescriptionAddtags field nameTag name returned in output
Delivery Point Suffixdeliverypointsuffixdeliverypointsuffix
Unique Delivery Point Reference Number (UDPRN)udprnuniquedeliverypointreferencenumber
Multiple Occupancy Count - count of the number of multiple occupancy addresses for the delivery pointmultipleoccupancycountmultipleoccupancycount
Administrative County (top tier local government)administrativecountyadministrativecounty
Former Postal Countypostalcountypostalcounty
Traditional Countytraditionalcountytraditionalcounty
User Category (residential 'R', Non-residential 'N', or Large 'L')usercategoryusercategory
Sortcode (for Royal Mail Mailsort)sortcodesortcode
Country code (within the United Kingdom)countrycodecountrycode
Country name (within the United Kingdom)countrycountry
Welsh language alternative for dependent street fieldwelsh_dependentstreetwelsh_dependentstreet
Welsh language alternative for street fieldwelsh_streetwelsh_street
Welsh language alternative for double dependent locality fieldwelsh_doubledependentlocalitywelsh_doubledependentlocality
Welsh language alternative for dependent locality fieldwelsh_dependentlocalitywelsh_dependentlocality
Welsh language alternative for post town fieldwelsh_posttownwelsh_posttown

Coordinates

DescriptionAddtags field nameTag name returned in output
Easting OS Grid Reference (1m precision in units of 1m)grideast1metregrideasting
Northing OS Grid Reference (1m precision in units of 1m)gridnorth1metregridnorthing
Latitude (OSGB36)latitudeosgb36latitudeosgb
Longitude (OSGB36)longitudeosgb36longitudeosgb
Latitude (ETRS89)latitudeetrs89latitude
Longitude (ETRS89)longitudeetrs89longitude

Census data

DescriptionAddtags field nameTag name returned in output
2011 Census Output Areaoa11oa11
2011 Census Lower Layer Super Output Arealsoa11lsoa11
2011 Census Middle Layer Super Output Areamsoa11msoa11
2001 Census Output Areacensusoutputarea_2001censusoutputarea_2001
2001 Census Lower Layer Super Output Areacensuslowerlayersuperoutputarea_2001censuslowerlayersuperoutputarea_2001
2001 Census Middle Layer Super Output Areacensusmiddlelayersuperoutputarea_2001censusmiddlelayersuperoutputarea_2001
2001 Census Area Statistics (CAS) Wardcensusareastatisticswardcodecensusareastatisticswardcode
2005 Statistical Wardstatisticalwardcode_2005statisticalwardcode_2005

NHS data

DescriptionAddtags field nameTag name returned in output
NHS Commissioning Region Code (ONS GSS)commissioningregioncode_gsscommissioningregioncode_gss
NHS Commissioning Region Namecommissioningregionnamecommissioningregionname
NHS Area Team Code (NHS)areateamcode_nhsareateamcode_nhs
NHS Area Team Code (ONS GSS)areateamcode_gssareateamcode_gss
NHS Area Team Nameareateamnameareateamname
NHS Clinical Commissioning Group Code (NHS)clinicalcommissioninggroupcode_nhsclinicalcommissioninggroupcode_nhs
NHS Clinical Commissioning Group Code (ONS GSS)clinicalcommissioninggroupcode_gssclinicalcommissioninggroupcode_gss
NHS Clinical Commissioning Group Nameclinicalcommissioninggroupnameclinicalcommissioninggroupname

Government data

DescriptionAddtags field nameTag name returned in output
Local Authority Ward Codelocalauthoritywardcodelocalauthoritywardcode
Local Authority Codelocalauthoritycodelocalauthoritycode
Local Authority Namelocalauthoritynamelocalauthorityname
Electoral Ward Codeelectoralwardcodeelectoralwardcode
Electoral Ward Nameelectoralwardnameelectoralwardname
Electoral County Codeelectoralcountycodeelectoralcountycode
Electoral County Nameelectoralcountynameelectoralcountyname
Parish Codeparishcodeparishcode
Westminster Parliamentary Constituency Codeparliamentaryconstituencycodeparliamentaryconstituencycode
Westminster Parliamentary Constituency Nameparliamentaryconstituencynameparliamentaryconstituencyname
European Electoral Region Codeeuropeanelectoralregioncodeeuropeanelectoralregioncode
European Electoral Region Nameeuropeanelectoralregionnameeuropeanelectoralregionname
National Park Namenationalparknamenationalparkname
National Park Codenationalparkcodenationalparkcode

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

CountryBuildingsStreetsTownsCountry Code
AfghanistanAF
Aland IslandsAX
AlbaniaAL
AlgeriaDZ
American SamoaAS
AndorraAD
AngolaAO
AnguillaAI
AntarcticaAQ
Antigua and BarbudaAG
ArgentinaAR
ArmeniaAM
ArubaAW
AustraliaAU
AustriaAT
AzerbaijanAZ
BahamasBS
BahrainBH
BangladeshBD
BarbadosBB
BelarusBY
BelgiumBE
BelizeBZ
BeninBJ
BermudaBM
BhutanBT
BoliviaBO
Bonaire, Sint Eustatius And SabaBQ
Bosnia and HerzegovinaBA
BotswanaBW
Br. Indian Ocean Ter.IO
BrazilBR
Brunei DarussalamBN
BulgariaBG
Burkina FasoBF
BurundiBI
CambodiaKH
CameroonCM
CanadaCA
Cape VerdeCV
Cayman IslandsKY
Central African Rep.CF
ChadTD
ChileCL
ChinaCN
Christmas IslandCX
Cocos (Keeling) IslandsCC
ColombiaCO
ComorosKM
Congo (Dem. Rep.)CD
Congo (Rep.)CG
Cook IslandsCK
Costa RicaCR
Côte d'IvoireCI
CroatiaHR
CubaCU
CuracaoCW
CyprusCY
Czech RepublicCZ
DenmarkDK
DjiboutiDJ
DominicaDM
Dominican RepublicDO
EcuadorEC
EgyptEG
El SalvadorSV
Equatorial GuineaGQ
EritreaER
EstoniaEE
EthiopiaET
Falkland Is. (Malvinas)FK
Faröe IslandsFO
FijiFJ
FinlandFI
FranceFR
French GuianaGF
French PolynesiaPF
French Southern TerritoriesTF
GabonGA
GambiaGM
GeorgiaGE
GermanyDE
GhanaGH
GibraltarGI
GreeceGR
GreenlandGL
GrenadaGD
GuadeloupeGP
GuamGU
GuatemalaGT
GuineaGN
Guinea-BissauGW
GuyanaGY
HaitiHT
HondurasHN
Hong KongHK
HungaryHU
IcelandIS
IndiaIN
IndonesiaID
IranIR
IraqIQ
IrelandIE
IsraelIL
ItalyIT
JamaicaJM
JapanJP
JordanJO
KazakhstanKZ
KenyaKE
KiribatiKI
Korea (Dem. Rep.)KP
Korea (Rep.)KR
KuwaitKW
KyrgyzstanKG
LaosLA
LatviaLV
LebanonLB
LesothoLS
LiberiaLR
LibyaLY
LiechtensteinLI
LithuaniaLT
LuxembourgLU
MacaoMO
Macedonia, TFYRMK
MadagascarMG
MalawiMW
MalaysiaMY
MaldivesMV
MaliML
MaltaMT
Marshall IslandsMH
MartiniqueMQ
MauritaniaMR
MauritiusMU
MayotteYT
MexicoMX
MicronesiaFM
MoldovaMD
MonacoMC
MongoliaMN
MontenegroME
MontserratMS
MoroccoMA
MozambiqueMZ
MyanmarMM
NamibiaNA
NauruNR
NepalNP
NetherlandsNL
New CaledoniaNC
New ZealandNZ
NicaraguaNI
NigerNE
NigeriaNG
NiueNU
Norfolk IslandNF
Northern Mariana IslandsMP
NorwayNO
OmanOM
PakistanPK
PalauPW
Palestinian TerritoryPS
PanamaPA
Papua New GuineaPG
ParaguayPY
PeruPE
PhilippinesPH
PitcairnPN
PolandPL
PortugalPT
Puerto RicoPR
QatarQA
RéunionRE
RomaniaRO
RussiaRU
RwandaRW
S. Georgia and S. SandwichGS
Saint HelenaSH
Saint LuciaLC
Saint MartinMF
Saint Pierre and MiquelonPM
Saint-BarthélemyBL
SamoaWS
San MarinoSM
Sao Tomé and PrincipeST
Saudi ArabiaSA
SenegalSN
SerbiaRS
SeychellesSC
Sierra LeoneSL
SingaporeSG
Sint MaartenSX
SlovakiaSK
SloveniaSI
Solomon IslandsSB
SomaliaSO
South AfricaZA
South SudanSS
SpainES
Sri LankaLK
St. Kitts and NevisKN
St. Vincent and GrenadinesVC
SudanSD
SurinameSR
Svalbard and Jan MayenSJ
SwazilandSZ
SwedenSE
SwitzerlandCH
SyriaSY
TaiwanTW
TajikistanTJ
TanzaniaTZ
ThailandTH
Timor-LesteTL
TogoTG
TokelauTK
TongaTO
Trinidad and TobagoTT
TunisiaTN
TurkeyTR
TurkmenistanTM
Turks and Caicos Is.TC
TuvaluTV
UgandaUG
UkraineUA
United Arab EmiratesAE
United KingdomGB
United States Minor Outlying IslandsUM
United States of AmericaUS
United States Virgin IslandsVI
UruguayUY
UzbekistanUZ
VanuatuVU
Vatican CityVA
VenezuelaVE
Viet NamVN
Virgin Islands, BritishVG
Wallis and FutunaWF
Western SaharaEH
YemenYE
ZambiaZM
ZimbabweZW

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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 1, 2, 3...0

UPRN lookup using AddressBase Premium

Lookup a record using a UPRN.

Uses the latest AddressBase Premium data from OS.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets 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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 1, 2, 3...0

Irish geocoding using Eircode

Lookup coordinates for an Eircode in Ireland.

Uses the latest ECAD data from Eircode.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
callbackSets 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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
callbackSets 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.

Contact us to access this feature with your API key.

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 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

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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
callbackSets 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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
callbackSets 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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
callbackSets 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

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited listSee Additional data fields
callbackSets the name of your JSONP callback function

Optional querystring parameters

ParameterDescriptionValuesDefault
formatSets the data format of the response; the default is json unless header of application/xml is detectedxml, jsonjson
identifierSets an identifier like "checkout" or "contactform" to help you group requests within your search history
linesSets the number of address lines over which to display the first part of each address in the response0, 1, 2, 3, 40
includeSpecifies the extra address fields to include within the address lines, using a comma-delimited listcounty, posttown, postcode
excludeSpecifies the address fields to exclude within the address lines, using a comma-delimited listpobox, organisation, departmentname, buildingname, subbuildingname, number, premise, dependentstreet, street, doubledependentlocality, dependentlocality
addtagsSpecifies the extra address fields to include within the response, using a comma-delimited list
postcodeonlyLimits the request to a postcode-only search rather than matching the search term on other parts of an addresstrue, falsefalse
aliasIncludes aliases for addresses known to and accepted by Royal Mailtrue, falsefalse
callbackSets the name of your JSONP callback function
pageSpecifies the page of results to return where 0 is the first page0, 1, 2, 3...0