Brief description of the API endpoints (source GISCO Address API > Endpoints:
| Endpoint | Description |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /countries
| Returns all country codes that are compatible with the address API. Check the coverage map for available countries and see here for a list of official country codes. |
| /provinces
| Returns all provinces within the specified country. Can also be used to get the province of a specified city. |
| /cities
| Returns all cities within a specified province or country. |
| /roads
| Returns all roads or streets within a specified city. |
| /housenumbers
| Returns all house numbers or names within the specified road. It is possible that in certain countries an address may not have a road component. In this case, if a road is not specified then the number of house numbers returned by the API is limited to 1000. |
| /postcodes
| Returns all postcodes within the specified address component (Country or Province or City). |
| /search
| The search endpoint allows structured queries to the address database. Please note that various combinations of each of the parameters can be used in order to retrieve the addresses that share an address component. The API is limited to a maximum of 100 addresses. |
| /reverse
| The API's reverse theme allows you to specify x and y coordinates in order to retrieve a structured address. |
| /bbox
| Returns a WKT bounding box for an address component depending on the parameters specified. |
| /copyright
| Returns the copyright text for each available country in the Address API. |
The resulting object may present the following variables:
| Property name | Description |
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| LD
| Refers to "Locator Designator" and represents the house number part of the address |
| TF
| Refers to "Thoroughfare" and represents the street or road part of the address |
| L0
| Refers to Level 0 of the API administrative levels. Values are country codes consisting of 2 characters. |
| L1
| Refers to Level 1 of the API administrative levels. Values are province names. Please note that "province" is a generic term that may differ between countries. |
| L2
| Refers to Level 2 of the API administrative levels. Values are town or city names. Please note that "city" is a generic term that may differ between countries. |
| PC
| Postal Code |
| N0
| Refers to "NUTS 0" |
| N1
| Refers to "NUTS 1" |
| N2
| Refers to "NUTS 2" |
| N3
| Refers to "NUTS 3" |
| X
and Y
| Refers to the x and y coordinates of the address point |
| OL
| Refers to the address' Open Location Code |
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.