Learn how to search for businesses, POIs, and geographic locations with the geocoding service.

Place finding is the process of searching for a place name or POI to find its address and location. You can use the Geocoding service to find places such as coffee shops, gas stations, or restaurants for any geographic location around the world. You can search for places by name or by using categories. You can search near a location or you can search globally.
In this tutorial, you will use a locator
to access the Geocoding service and find places by place category. Pop-ups are used to display the place name and address.
Prerequisites
Steps
Create a new pen
- To get started, either complete the Display a map tutorial or .
Get an access token
You need an access token with the correct privileges to access the location services 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 > Basemaps
- Location services > Geocoding
- Privileges
- In CodePen, set
esri
to your access token.Config.api Key Use dark colors for code blocks var esriConfig = { apiKey: "YOUR_ACCESS_TOKEN", };
To learn about other ways to get an access token, go to Types of authentication.
Update the map
A streets basemap layer is typically used in geocoding applications. Update the basemap
attribute to use the arcgis/navigation
basemap layer and change the position of the map to center on Tromso.
-
Update the
basemap
attribute fromarcgis/topographic
toarcgis/navigation
and the center to18.9553,69.6492
.Use dark colors for code blocks <arcgis-map basemap="arcgis/navigation" center="18.9553,69.6492" zoom="13"> <arcgis-zoom slot="top-left"></arcgis-zoom> </arcgis-map>
Create a place category selector
You filter place search results by providing a location and category. Places can be filtered by categories such as coffee shop, gas station, and hotels. Use a Calcite Select component to provide a list of several categories from which to choose.
-
Inside a Calcite Block component, add a Calcite Select component with an id of
places-select
and a Label ofChoose a place type
.Use dark colors for code blocks <arcgis-map basemap="arcgis/navigation" center="18.9553,69.6492" zoom="13"> <arcgis-zoom slot="top-left"></arcgis-zoom> <calcite-block expanded slot="top-right"> <calcite-label id="places-select-label"> Choose a place type <calcite-select id="places-select"> </calcite-select> </calcite-label> </calcite-block> </arcgis-map>
-
Create an option component for each category and add it to the Select component.
Use dark colors for code blocks <arcgis-map basemap="arcgis/navigation" center="18.9553,69.6492" zoom="13"> <arcgis-zoom slot="top-left"></arcgis-zoom> <calcite-block expanded slot="top-right"> <calcite-label id="places-select-label"> Choose a place type <calcite-select id="places-select"> <calcite-option value="Parks and Outdoors">Parks and Outdoors</calcite-option> <calcite-option value="Coffee shop">Coffee shop</calcite-option> <calcite-option value="Gas station">Gas station</calcite-option> <calcite-option value="Food">Food</calcite-option> <calcite-option value="Hotel">Hotel</calcite-option> </calcite-select> </calcite-label> </calcite-block> </arcgis-map>
Add a script
-
Add a script tag with the type attribute set to module, to the bottom of the body.
Use dark colors for code blocks <body> <arcgis-map basemap="arcgis/navigation" center="18.9553,69.6492" zoom="13"> <arcgis-zoom slot="top-left"></arcgis-zoom> <calcite-block expanded slot="top-right"> <calcite-label id="places-select-label"> Choose a place type <calcite-select id="places-select"> <calcite-option value="Parks and Outdoors">Parks and Outdoors</calcite-option> <calcite-option value="Coffee shop">Coffee shop</calcite-option> <calcite-option value="Gas station">Gas station</calcite-option> <calcite-option value="Food">Food</calcite-option> <calcite-option value="Hotel">Hotel</calcite-option> </calcite-select> </calcite-label> </calcite-block> </arcgis-map> <script type="module"> </script> </body>
-
Using
$arcgis.import
, add theGraphic
andlocator
modules.The ArcGIS Maps SDK for JavaScript is available via CDN and npm, but this tutorial is based on CDN. The
$arcgis.import
global function accepts a module path or array of module paths, and returns a promise that resolves with the requested modules. This function can only be used when working with the CDN; otherwise, use the standard import syntax. To learn more about the SDK's different modules, visit the References page.Use dark colors for code blocks <script type="module"> const [Graphic, locator] = await $arcgis.import([ "@arcgis/core/Graphic", "@arcgis/core/rest/locator", ]); </script>
Define variables for the components
Define variables for the components you will use in the app. You will use these variables to access the components and their properties.
-
Define variables for the
map
andplaces
components.Select Use dark colors for code blocks <script type="module"> const [Graphic, locator] = await $arcgis.import([ "@arcgis/core/Graphic", "@arcgis/core/rest/locator", ]); const placesSelectElement = document.querySelector("#places-select"); const viewElement = document.querySelector("arcgis-map"); </script>
Define the service url
You can use a locator
to access the Geocoding service.
- Define a variable,
locator
, to the URL for the Geocoding service.Url Use dark colors for code blocks <script type="module"> const [Graphic, locator] = await $arcgis.import([ "@arcgis/core/Graphic", "@arcgis/core/rest/locator", ]); const placesSelectElement = document.querySelector("#places-select"); const viewElement = document.querySelector("arcgis-map"); const locatorUrl = "http://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer"; </script>
Search for places
To find places, use the locator
address
function. Performing a local search based on a category requires a location from which to search and a category name. The function sends a request to the Geocoding service and the service returns place candidates with a name, address and location information. Use the function to perform a search and add the results to the map as graphics.
-
Create a
find
function and callPlaces address
. Set theTo Locations location
,categories
andout
properties.Fields Use dark colors for code blocks <script type="module"> const [Graphic, locator] = await $arcgis.import([ "@arcgis/core/Graphic", "@arcgis/core/rest/locator", ]); const placesSelectElement = document.querySelector("#places-select"); const viewElement = document.querySelector("arcgis-map"); const locatorUrl = "http://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer"; async function findPlaces(category, point) { const results = await locator.addressToLocations(locatorUrl, { location: point, categories: [category], maxLocations: 25, outFields: ["Place_addr", "PlaceName"], }); } </script>
-
Clear the view of existing pop-ups and graphics.
Use dark colors for code blocks async function findPlaces(category, point) { const results = await locator.addressToLocations(locatorUrl, { location: point, categories: [category], maxLocations: 25, outFields: ["Place_addr", "PlaceName"], }); viewElement.closePopup(); viewElement.graphics.removeAll(); }
-
Create a
Graphic
for each result returned. Set theattributes
,geometry
,symbol
andpopup
properties for each. Add each graphic to theTemplate view
.Element Use dark colors for code blocks async function findPlaces(category, point) { const results = await locator.addressToLocations(locatorUrl, { location: point, categories: [category], maxLocations: 25, outFields: ["Place_addr", "PlaceName"], }); viewElement.closePopup(); viewElement.graphics.removeAll(); results.forEach((result) => { viewElement.graphics.add( new Graphic({ attributes: result.attributes, geometry: result.location, symbol: { type: "simple-marker", color: "#000000", size: "12px", outline: { color: "#ffffff", width: "2px", }, }, popupTemplate: { title: "{PlaceName}", content: "{Place_addr}", }, }), ); }); }
-
Call the
find
function when the Map loads and each time the Map changes and becomes stationary by listening to the arcgisViewChange event.Places Use dark colors for code blocks viewElement.addEventListener("arcgisViewChange", () => { if (viewElement.stationary) { findPlaces(placesSelectElement.value, viewElement.center); } });
-
Places for parks should be displayed on the map. By dragging the map, you will see new places populate the view.
Add a handler to select a category
Use an event handler to call the find
function when the category is changed.
- Add a
calcite
event listener to listen for category changes.Select Change Use dark colors for code blocks viewElement.addEventListener("arcgisViewChange", () => { if (viewElement.stationary) { findPlaces(placesSelectElement.value, viewElement.center); } }); placesSelectElement.addEventListener("calciteSelectChange", () => { findPlaces(placesSelectElement.value, viewElement.center); });
Run the app
In CodePen, run your code to display the map.
When you select a category, you should see places displayed in the center of the map for the category you selected. The search occurs when the map loads and when the map view position changes by zooming or panning. You can also click on the graphics to display pop-ups with the name and address information for each place.
What's next?
Learn how to use additional API features and ArcGIS services in these tutorials: