Find nearby places and details

Learn how to access the places service.

Find nearby places and details using API key authentication

A nearby search finds places within a given radius of a location using the places service. The location typically represents a point on a map or the geolocation of a device.

To perform a nearby search, you use the places package from ArcGIS REST JS. With the results of the search, you can make another request to the service and return place attributes including the name, categories, ratings, and store hours.

Prerequisites

An ArcGIS Location Platform account.

Steps

Get the starter app

Select a type of authentication below and follow the steps to create a new application.

If you are using the CDN libraries, to get started.

Set up authentication

Create developer credentials in your portal for the type of authentication you selected.

Create a new API key credential 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 > Places
Copy the API key access token to your clipboard when prompted.

Set developer credentials

Use the API key or OAuth developer credentials so your application can access location services.

Update the accessToken variable to use your API key.

Use dark colors for code blocks
    const accessToken = "YOUR_ACCESS_TOKEN";

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL with the client ID and redirect URL of your OAuth credentials.

index.html
Use dark colors for code blocks
    const authentication = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
       clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
       redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
       portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

callback.html
Use dark colors for code blocks
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

Run the app and ensure you can sign in successfully.

If you are unable to sign in, make sure you have the correct redirect URL and port. This URL varies based on your application and typically takes the format of https://<server>[:port]/callback.html or http://my-arcgis-app:/auth. For example, if you are running an application on http://127.0.0.1:5500/, set http://127.0.0.1:5500/callback.html as your redirect URL in the index.html and callback.html file and your developer credential. They all have to match!

Request nearby places

Copy and paste the code below, following the steps to make a request to the Places service.

Reference the arcgis-rest-request and arcgis-rest-places libraries either through CDN, ES Modules, or Node JS.
Define the parameters needed for the request.
Call the Places service and handle the results.

Expand
Use dark colors for code blocks
  <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_URL", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    arcgisRest.findPlacesNearPoint({
      x: -118.46651, // Venice Beach, CA
      y: 33.98621,
      categoryIds: ["16000"], // Arts and Outdoors category
      radius: 750,
      authentication
    })
      .then((response) => {
        console.log("Search results:", response.results);
        document.getElementById("result").textContent = JSON.stringify(response.results, null, 2);

      }).catch((error) => {
        document.getElementById("result").textContent += error
      });

  </script>
Expand

The service will return a list of up to 20 nearby places that match the search criteria.

The places service returns a maximum of 20 search results at a time. To find more places that match your query, you can paginate through place results by making additional requests with a formatted URL. To learn how to do this, go to the Paginate search results example in the Places introduction.

Request place details

Each place returned from the places service includes a unique Place ID. Use this ID and ArcGIS REST JS to request additional information about one of the places returned in the previous step.

Expand
Use dark colors for code blocks
  <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_URL", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    arcgisRest.findPlacesNearPoint({
      x: -118.46651, // Venice Beach, CA
      y: 33.98621,
      categoryIds: ["16000"], // Arts and Outdoors category
      radius: 750,
      authentication
    })
      .then((response) => {
        console.log("Search results:", response.results);
        document.getElementById("result").textContent = JSON.stringify(response.results, null, 2);

        getDetails(response.results[0].placeId);

      }).catch((error) => {
        document.getElementById("result").textContent += error
      });

    function getDetails(placeId) {
      arcgisRest.getPlaceDetails({
        placeId: placeId,
        requestedFields: ["all"],
        authentication
      }).then((response) => {
        console.log("Place details:", response.placeDetails);
        document.getElementById("result").textContent += JSON.stringify(response.placeDetails, null, 2);
      });
    }

  </script>
Expand

Run the app

Run the app.

The result should look similar to this.

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Find places in a bounding box

Perform a text-based search to find places within a bounding box.

Find place addresses

Find coffee shops, gas stations, restaurants and other nearby places by accessing the Geocoding service.

Find a route and directions

Find a route and directions for an origin and destination by accessing the route service.