Find nearby places and details

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

You need an ArcGIS Developer or ArcGIS Online account to access the developer dashboard and create an API key.

Steps

Create a new pen

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

Get an API Key

To access location services, you need an API key or OAuth 2.0 access token. To learn how to create and scope your key, visit the Create an API key tutorial.

Go to your dashboard to get an API key. The API key must be scoped to access the services used in this tutorial.
In CodePen, update apiKey to use your key.

Request nearby places

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

Reference the ArcGIS REST JS libraries either through CDN, ES Modules, or Node JS.
Set the apiKey with the API key from your dashboard.
Define the parameters needed for the request.
Call the Places service and handle the results.

CDNCDNES ModulesNode JS
Expand
Use dark colors for code blocks
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-places@1.0.0/dist/bundled/places.umd.js"></script>

    <script>
      /* when including ArcGIS REST JS all exports are available
    from the same arcgisRest global */

    const apiKey = "YOUR_API_KEY";

    const authentication = arcgisRest.ApiKeyManager.fromKey(apiKey);

    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);

    });

    </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.

CDNCDNES ModulesNode JS
Expand
Use dark colors for code blocks
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-places@1.0.0/dist/bundled/places.umd.js"></script>

    <script>
      /* when including ArcGIS REST JS all exports are available
    from the same arcgisRest global */

    const apiKey = "YOUR_API_KEY";

    const authentication = arcgisRest.ApiKeyManager.fromKey(apiKey);

    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);

    });

    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

Result

Below are the responses from the places service:

Nearby results

Use dark colors for code blocks

Copy

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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
[
  {
    "place": {
      "placeId": "3ab8fd70a4af0ea5ee52fd16a030ae93",
      "location": {
        "x": -118.466722,
        "y": 33.984622
      },
      "categories": [
        {
          "categoryId": "16037",
          "label": "Playground"
        }
      ],
      "name": "Linnie Canal Park",
      "parentPlaceId": null,
      "distance": 177.7
    },
    "distance": 177.7
  },
  {
    "place": {
      "placeId": "bed7c3f80c0a3094ecc4149f2353182c",
      "location": {
        "x": -118.46656,
        "y": 33.984562
      },
      "categories": [
        {
          "categoryId": "16009",

See full response

Place details

Use dark colors for code blocks

Copy

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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
{
  "place": {
    "placeId": "3ab8fd70a4af0ea5ee52fd16a030ae93",
    "location": {
      "x": -118.466722,
      "y": 33.984622
    },
    "categories": [
      {
        "categoryId": "16037",
        "label": "Playground"
      }
    ],
    "name": "Linnie Canal Park",
    "parentPlaceId": null
  },
  "description": null,
  "address": {
    "streetAddress": "2401 Dell Ave",
    "extended": "# 2418",
    "locality": "Venice",
    "designatedMarketArea": "Los Angeles",
    "region": "CA",
    "postcode": "90291",
    "poBox": null,
    "country": "US",
    "adminRegion": null,
    "postTown": null,
    "neighborhood": ["Venice"],
    "censusBlockId": "060372739024009"

See full response

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.