Reverse geocode

Learn how to find an address near a location with the ArcGIS Geocoding service.

Prerequisites

Steps

Create a new app

1. Open a terminal and create a new folder for your project.

   Use dark colors for code blocksCopy

   1
   2
   mkdir reverse-geocode
   cd reverse-geocode

2. Initialize a new Node.js project. This creates a package.json file.

   Use dark colors for code blocksCopy

   1
   npm init

3. Install the required packages.

   Use dark colors for code blocksCopy

   1
   npm install @esri/arcgis-rest-request @esri/arcgis-rest-geocoding --save

4. Create a new JavaScript file named index.js.

   Use dark colors for code blocksCopy

   1
   touch index.js

Get an access token

Create a new API key credentialAPI key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential.Learn more with the correct privileges to get an access token.

1. Go to the Create an API key tutorial and create an API key with the following privilege(s)Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS.Learn more:
   
   • Privileges:
     • Location services > Geocoding
2. Copy the API key access token to your clipboard when prompted.

Make a request

1. Open your index.js file and import the packages.

   index.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   
   import { ApiKeyManager } from "@esri/arcgis-rest-request";
   import { reverseGeocode } from "@esri/arcgis-rest-geocoding";
   
   

2. Paste in your access token.

   index.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   
   import { ApiKeyManager } from "@esri/arcgis-rest-request";
   import { reverseGeocode } from "@esri/arcgis-rest-geocoding";
   
   const accessToken = "YOUR_ACCESS_TOKEN";
   const authentication = ApiKeyManager.fromKey(accessToken);
   
   

3. Make a request to the ArcGIS Geocoding serviceA geocoding service is a service that can search for addresses, place addresses, businesses, reverse geocode coordinates to addresses, provide suggestions for places, and perform bulk geocoding. It is hosted by Esri as the ArcGIS Geocoding service and can also be hosted in ArcGIS Enterprise.Learn more and print the results.

   index.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   
   import { ApiKeyManager } from "@esri/arcgis-rest-request";
   import { reverseGeocode } from "@esri/arcgis-rest-geocoding";
   
   const accessToken = "YOUR_ACCESS_TOKEN";
   const authentication = ApiKeyManager.fromKey(accessToken);
   
   reverseGeocode({
     location: [-79.3871, 43.6426], // [lon, lat]
     authentication
   }).then((response) => {
     console.log(JSON.stringify(response, null, 2));
   });

4. Save the file, then run it from the terminal.

   Use dark colors for code blocksCopy

   1
   node index.js

You should now see the results printed in your console.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "address": {
    "Match_addr": "CN Tower",
    "LongLabel": "CN Tower, 301 Front St W, Toronto, Ontario, M5V, CAN",
    "ShortLabel": "CN Tower",
    "Addr_type": "POI",
    "Type": "Tourist Attraction",
    "PlaceName": "CN Tower",
    "AddNum": "301",
    "Address": "301 Front St W",
    "Block": "",
    "Sector": "",
    "Neighborhood": "Waterfront Communities-the Island",
    "District": "Toronto",
    "City": "Toronto",

What's next?

Learn how to use additional location services in these tutorials: