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 Geocoding service to find coffee shops within a specified location and distance.
Prerequisites
You need an ArcGIS Location Platform or ArcGIS Online account.
Steps
Create a new pen
- If you are using the CDN libraries, to get started.
Get an access token
You need an access token with the correct privileges to access the resources used in this tutorial.
-
Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges:
- Location services > Geocoding
- Privileges:
-
Copy the API key access token to your clipboard when prompted.
-
In CodePen, update the
accessvariable to use your access token.Token Use dark colors for code blocks Copy const accessToken = "YOUR_ACCESS_TOKEN"; const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
To learn about the other types of authentication available, go to Types of authentication.
Make the request
Copy and paste the code below, following the steps to make a request to the Geocoding service.
-
Reference the ArcGIS REST JS libraries either through CDN, ES Modules, or Node JS.
-
- Set the
accesswith an API key access token from API key credentials.Token
- Set the
-
Define the parameters needed for the request.
-
Call the Geocoding service and handle the results.
<!-- require ArcGIS REST JS libraries from https://unpkg.com -->
<script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
<script src="https://unpkg.com/@esri/arcgis-rest-geocoding@4/dist/bundled/geocoding.umd.js"></script>
<script>
/* when including ArcGIS REST JS all exports are available
from the same arcgisRest global */
const accessToken = "YOUR_ACCESS_TOKEN";
const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
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>
Result
Below is the response from the service:
[
{
"address": "Acoffee",
"location": {
"x": 144.98561000000007,
"y": -37.79833999999994,
"spatialReference": {
"wkid": 4326,
"latestWkid": 4326
}
},
"score": 100,
"attributes": {
"Loc_name": "World",
"Status": "M",
"Score": 100,
"Match_addr": "Acoffee",
"LongLabel": "Acoffee, 30 Sackville St, Collingwood, Melbourne, Victoria, 3066, AUS",
"ShortLabel": "Acoffee",
"Addr_type": "POI",
"Type": "Coffee Shop",
"PlaceName": "Acoffee",
"Place_addr": "30 Sackville St, Collingwood, Melbourne, Victoria, 3066",
"Phone": "+61 3-94173337",
"URL": "",
"Rank": 19,
"AddBldg": "",
"AddNum": "30",
"AddNumFrom": "",
"AddNumTo": "",
What's next?
Learn how to use additional ArcGIS location services in these tutorials:
Find a route and directions
Find a route and directions for an origin and destination by accessing the route service.
Get local data
Query regional facts, spending trends, and psychographics with the GeoEnrichment service.
Find service areas
Create a service area that can be reached from a location within a drive time with the route service.