apoc.spatial.geocode

Details

Syntax

apoc.spatial.geocode(location [, maxResults, quotaException, config ]) :: (location, data, latitude, longitude, description)

Description

Returns the geographic location (latitude, longitude, and description) of the given address using a geocoding service (default: OpenStreetMap).

Input arguments

Name

Type

Description

location

STRING

The location to search for.

maxResults

INTEGER

The maximum number of returned results. The default is: 100.

quotaException

BOOLEAN

Whether or not to throw an exception when the maximum request quota is reached. The default is: false.

config

MAP

{ provider = 'osm' :: STRING, url :: STRING, reverseUrl: :: STRING, key :: STRING }. The default is: {}.

Return arguments

Name

Type

Description

location

MAP

A detailed map of information on the found location.

data

MAP

A map of returned data from the given provider.

latitude

FLOAT

The latitude of the found location.

longitude

FLOAT

The longitude of the found location.

description

STRING

A description of the found location.

Usage Examples

CALL apoc.spatial.geocode('Union House, London');
Results
location data latitude longitude description

{description: "Union House, 182-194, Union Street, Bankside, Southwark, London Borough of Southwark, London, Greater London, England, SE1 0LR, Unite d Kingdom", latitude: 51.503819199999995, longitude: -0.10101882640252435}

{osm_type: "way", osm_id: 77765231, licence: "Data © OpenStreetMap contri butors, ODbL 1.0. https://osm.org/copyright", boundingbox: ["51.5037439", "51.5038945", "-0.1013092", "-0.1007285"], importance: 0.31100000000000005, lon: "-0.10101882640252435", display_name: "Union House, 182-194, Union Street, Bankside, Southwark, London Borough of Southwark, London, Greater Lond on, England, SE1 0LR, United Kingdom", type: "yes", class: "building", place_id: 104116750, lat: "51.503819199999995"}

51.503819199999995

-0.10101 882640252435

"Union House, 182-194, Union Street, Bankside, Southwark, London Borough of Southwark, London, Greater London, England, SE1 0LR, United Kingdom"

{description: "Union House, Shepherds Bush Green, Brook Green, London Borough of Hammersmith and Fulham, London, Greater London, England, W12 7DP, U nited Kingdom", latitude: 51.504723, longitude: -0.2249915937565324}

{osm_type: "way", osm_id: 159245997, licence: "Data © OpenStreetMap contr ibutors, ODbL 1.0. https://osm.org/copyright", boundingbox: ["51.5045808", "51.5048507", "-0.2251614", "-0.2248218"], importance: 0.31100000000000005, lon: "-0.2249915937565324", display_name: "Union House, Shepherds Bush Green, Brook Green, London Borough of Hammersmith and Fulham, London, Greater London, England, W12 7DP, United Kingdom", type: "yes", class: "building", place_id: 123432321, lat: "51.504723"}

51.504723

-0.22499 15937565324

"Union House, Shepherds Bush Green, Brook Green, London Borough of Hammersmith and Fulham, London, Greater London, England, W12 7DP, Un ited Kingdom"

{description: "Union House, 6, Martin Lane, Bishopsgate, City of London, Greater London, England, EC4R 0DP, United Kingdom", latitude: 51.510519, lo ngitude: -0.08806049069724674}

{osm_type: "way", osm_id: 809354346, licence: "Data © OpenStreetMap contr ibutors, ODbL 1.0. https://osm.org/copyright", boundingbox: ["51.5104519", "51.5106113", "-0.0882068", "-0.0878968"], importance: 0.30100000000000005, lon: "-0.08806049069724674", display_name: "Union House, 6, Martin Lane, Bishopsgate, City of London, Greater London, England, EC4R 0DP, United Kingd om", type: "commercial", class: "building", place_id: 289689410, lat: "51.510519"}

51.510519

-0.08806 049069724674

"Union House, 6, Martin Lane, Bishopsgate, City of London, Greater London, England, EC4R 0DP, United Kingdom"