Find places in a bounding box

A bounding box search finds places within an extent using the places service. An extent typically represents the visible area of a map. To perform a bounding box search, you use the places package from ArcGIS REST JS.

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

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

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

Make the request

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

  1. Reference the ArcGIS REST JS libraries either through CDN, ES Modules, or Node JS.

  2. Set the apiKey with the API key from your dashboard.

  3. Define the parameters needed for the request.

  4. Call the Places service and handle the results.

CDNCDNES ModulesNode JS
Expand
Use dark colors for code blocks
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
    <!-- 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.findPlacesWithinExtent({
        xmin: -115.2, // Coordinates around the Las Vegas Strip
        ymin: 36.09,
        xmax:  -115.1,
        ymax: 36.161,
        searchText: "Night Clubs", // Search for "Night Clubs"
        authentication,
        f:"geojson"
    })
    .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.

Result

Below is the response from the service:

Use dark colors for code blocksCopy
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
[
  {
    "place": {
      "placeId": "68cf4e32bd935d54748de24a95629603",
      "location": {
        "x": -115.186432,
        "y": 36.118848
      },
      "categories": [
        {
          "categoryId": "10032",
          "label": "Night Club"
        },
        {
          "categoryId": "13009",
          "label": "Cocktail Bar"
        }
      ],
      "name": "Crown Night Club",
      "parentPlaceId": null
    }
  },
  {
    "place": {
      "placeId": "636406dc6564e4ad662a2fc86ac757ca",
      "location": {
        "x": -115.176537,
        "y": 36.092016
      },
      "categories": [

What's next?

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.