Learn how to access the ArcGIS Geocoding service.
Place finding is the process of searching for a place name or POI to find its address and location.
In this tutorial, you use the ArcGIS Geocoding service to find coffee shops within a specified location and distance.
Prerequisites
You need an ArcGIS Location Platform or ArcGIS Online account.
Steps
Get the starter app
Select a type of authentication and follow the steps to create a new app.
Choose API key authentication if you:
- Want the easiest way to get started.
- Want to build public applications that access ArcGIS Location Services and secure items.
- Have an ArcGIS Location Platform or ArcGIS Online account.
Choose user authentication if you:
- Want to build private applications.
- Require application users to sign in with their own ArcGIS account and access resources their behalf.
- Have an ArcGIS Online account.
To learn more about both types of authentication, go to Authentication.
Set up authentication
Set developer credentials
Use the API key or OAuth developer credentials so your application can access ArcGIS services.
Make the request
Copy and paste the code below, following the steps to make a request to the ArcGIS Geocoding service.
-
Reference the
arcgis-rest-requestandarcgis-rest-geocodinglibraries either through CDN, ES Modules, or Node JS. -
Define the parameters needed for the request.
-
Make a request to the ArcGIS Geocoding service and handle the results.
<script>
// when including ArcGIS REST JS all exports are available from the same arcgisRest global
/* Use for API key authentication */
const accessToken = "YOUR_ACCESS_TOKEN";
const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
// or
/* Use for user authentication */
// const authentication = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
// clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
// redirectUri: "YOUR_REDIRECT_URI", // The redirect URL registered in your OAuth credentials
// portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
// })
arcgisRest
.geocode({
params: {
category: "Coffee shop",
location: "144.9850916862488,-37.798297645411",
maxLocations: 20
},
outFields: "*",
authentication
})
.then((response) => {
console.log("Candidates:", response.candidates);
document.getElementById("result").textContent = JSON.stringify(response.candidates, null, 2);
});
</script>
Run the app
Run the app.
The result should look similar to this.What's next?
Learn how to use additional location services in these tutorials: