position

This endpoint returns the coordinates for a given UK postcode or Irish Eircode.

Ireland and Eircode: Enable access on your API key using the Data Options page or by contacting us.

Request URL

GET https://ws.postcoder.com/pcw/{apikey}/position/{countrycode}/{postcode}

Path parameters

ParameterDescriptionExample
apikeyYour API keyPCW45-12345-12345-1234X
countrycodeThe 2-character country code, use uk for UK or ie for Irelanduk
postcodeThe URL-encoded UK postcode or Irish Eircode that you wish to look upnr14%207pz

Querystring parameters

ParameterDescriptionExample
formatSets the format of the response, xml or json (default unless "application/xml" header is detected)format=json
identifierSpecifies 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 clientsidentifier=websiteA

Example requests and responses

Geocode the UK postcode of "NR14 7PZ"

GET https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/position/uk/nr14%207pz?format=json

[
	{
		"latitude": "52.5859730797",
		"longitude": "1.3491603533",
		"grideasting": "626976",
		"gridnorthing": "303951"
	}
]

Geocode the Irish Eircode of "D02X285"

GET https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/position/ie/D02X285?format=json

[
	{
		"latitude": "53.332067",
		"longitude": "-6.255492"
	}
]

Response fields

FieldDescriptionExample
latitudeThe ETRS89 latitude52.5859730797
longitudeThe ETRS89 longitude1.3491603533
grideastingThe Easting OS grid reference (1m precision in units of 1m)626976
gridnorthingThe Northing OS grid reference (1m precision in units of 1m)303951

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:

CountryRequest
UK0.9 credits
Ireland4.5 credits

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

Live Start Loading Now Chatting Offline