All requests must first be Authorized and must use the HTTP GET method over HTTPS. Results are encoded int UTF-8.
This call allows you to get the full address list from the Eircode database for a provided Eircode. An Eircode is a seven-character postcode consisting of two elements:
- Three Character Routing Key
- Four Character Unique Identifier
An Eircode should always be stored as a single string of seven upper case characters in IT systems, i.e. A96T927
An Eircode should always be presented in upper case as two parts separated by a space, on stationary, mail items, computer forms, etc. i.e. A96 T927 and never A96T927.
Please contact us for further details on the format of Eircodes, or a regex for front-end verification purposes.
The XSD file is available here
https://api.vision-net.ie/cws/2.4/eircode/{{EIRCODE}}?lang={{EIRCODE_LANGUAGE}}&format={{FORMAT}}&htmlEnc={{HTMLENC}}&userRef={{USER_REF}}
| Parameter | Type | Description |
|---|---|---|
| EIRCODE | D04V4X7 | A valid eircode. You should not include any spaces, so it should be 7 characters long. Please note, the test database only contains two records: D04V4X7 & A96T927 |
| lang | irish or english or both | Optional parameter where you can specify return language. Defaults to return both languages if available. |
| format | XML or JSON | Return the results in XML (default) or JSON format. |
| htmlEnc | 0 or 1 | If set to one, then String fields will be encoded in HTML format. For XML this parameter is forced to 1. For example, ampersands will be encoded as & |
| userRef | reference | Optional parameter to save a reference to the usage charge entry. |
Sample response for D04V4X7
Please be aware that multiple Address objects may be returned for the one Eircode.
https://api.vision-net.ie/cws/2.2/eircode/D04V4X7?lang=both&format=json
| Address Part | Field Name |
|---|---|
| Department | prem_dep |
| Organisation | prem_org |
| Sub Building Name (e.g. ‘Flat 1’) | prem_sub_building |
| Building Name (e.g. ‘Rose Cottage’) | prem_building_name |
| Building Number (e.g. 22) | prem_building_number |
| Building Group (e.g. ‘Marian Terrace’) | th_group |
| Primary Thoroughfare (e.g. ‘Griffith Road’) | th_primary |
| Secondary Thoroughfare (e.g. Navan Road’) | th_secondary |
| Primary Locality (e.g. ‘Cookstown Industrial Estate’) | loc_primary |
| Secondary Locality (e.g. ‘Manorhamilton’) | loc_secondary |
| Tertiary Locality (e.g. ‘Dublin 14’) | loc_town |
| Post County (e.g. ‘Cork’) | loc_county |
| Eircode (e.g. ‘A65F4E2’) | ecaf_eircode |
There are twelve possible address parts but no Postal Address contains more than eight address lines. The addr_1, addr_2... are the first nine non-null parts of the address.