gisco_addressapi: GISCO Address API
In giscoR: Download Map Data from GISCO API - Eurostat

gisco_addressapi

R Documentation

GISCO Address API

Description

Access the GISCO Address API, that allows to carry out both geocoding and reverse geocoding using a pan-european address database.

Each endpoint available is implemented through a specific function, see Details.

The API supports fuzzy searching (also referred to as approximate string matching) for all parameters of each endpoint.

Usage

gisco_addressapi_search(
  country = NULL,
  province = NULL,
  city = NULL,
  road = NULL,
  housenumber = NULL,
  postcode = NULL,
  verbose = FALSE
)

gisco_addressapi_reverse(x, y, country = NULL, verbose = FALSE)

gisco_addressapi_bbox(
  country = NULL,
  province = NULL,
  city = NULL,
  road = NULL,
  postcode = NULL,
  verbose = FALSE
)

gisco_addressapi_countries(verbose = FALSE)

gisco_addressapi_provinces(country = NULL, city = NULL, verbose = FALSE)

gisco_addressapi_cities(country = NULL, province = NULL, verbose = FALSE)

gisco_addressapi_roads(
  country = NULL,
  province = NULL,
  city = NULL,
  verbose = FALSE
)

gisco_addressapi_housenumbers(
  country = NULL,
  province = NULL,
  city = NULL,
  road = NULL,
  postcode = NULL,
  verbose = FALSE
)

gisco_addressapi_postcodes(
  country = NULL,
  province = NULL,
  city = NULL,
  verbose = FALSE
)

gisco_addressapi_copyright(verbose = FALSE)

Arguments

`country`	Country code (`country = "LU"`).
`province`	A province within a country. For a list of provinces within a certain country use the provinces endpoint (`gisco_addressapi_provinces(country = "LU")`).
`city`	A city within a province. For a list of cities within a certain province use the cities endpoint (`gisco_addressapi_cities(province = "capellen")`).
`road`	A road within a city.
`housenumber`	The house number or house name within a road or street.
`postcode`	Can be used in combination with the previous parameters.
`verbose`	Logical, displays information. Useful for debugging, default is `FALSE`.
`x`, `y`	x and y coordinates (as longitude and latitude) to be converted into a human-readable address.

Details

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

Value

A data.frame object in most cases, except gisco_addressapi_search(), gisco_addressapi_reverse() and gisco_addressapi_bbox(), that return a sf object.

Examples



# Cities in a region

gisco_addressapi_cities(country = "PT", province = "LISBOA")


# Geocode and reverse geocode with sf objects
# Structured search
struct <- gisco_addressapi_search(
  country = "ES", city = "BARCELONA",
  road = "GRACIA"
)

struct

# Reverse geocoding
reverse <- gisco_addressapi_reverse(x = struct$X[1], y = struct$Y[1])

reverse

giscoR documentation built on Sept. 11, 2024, 8:11 p.m.