How to build a place finding app | Documentation

1. Select a category
Find one or more category IDs with the category finder.
2. Search for places
Perform a search either near a location or within an extent.
3. Get place details
Request attributes to learn more about each place.

1. Select a category

The first step is to identify one or more place categoriesA place category is a name and ID for a group of related places. There are four levels of place categories. Each category contains a categoryId, fullLabel, and parents (IDs).Learn more for the types of places you are interested in. Categories are used to help filter search results so only the type of places you are interested in are returned. All categories have a name and a unique ID. To help find the appropriate category (and ID) you can use the /categories request.

The steps to find a category are:

Reference the places service.
Define a filter category.
Set the access token.

Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/categories?filter=<CATEGORY>&token=<ACCESS_TOKEN>&f=pjson

APIs

ArcGIS API for Python

ArcGIS REST JS

Use dark colors for code blocks

Copy

1
2
3
4
5
6
7
8
9
10
import requests

url = "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/categories"
params = {
    "f": "pjson",
    "token": "ACCESS_TOKEN"
}

response = requests.get(url, params=params)
print(response.text)

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/categories?token=<ACCESS_TOKEN>&f=pjson'

Run in Postman

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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

{
  "categories": [
    {
      "categoryId": "4d4b7104d754a06370d81259",
      "fullLabel": [
        "Arts and Entertainment"
      ],
      "parents": []
    },
    {
      "categoryId": "4bf58dd8d48988d182941735",
      "fullLabel": [
        "Arts and Entertainment",
        "Amusement Park"
      ],
      "parents": [
        "4d4b7104d754a06370d81259"
      ]
    },
    {
      "categoryId": "5109983191d435c0d71c2bb1",
      "fullLabel": [
        "Arts and Entertainment",
        "Amusement Park",
        "Attraction"
      ],
      "parents": [
        "4d4b7104d754a06370d81259",
        "4bf58dd8d48988d182941735"
      ]
    },
    // More categories
  ]
}

See full category list

2. Search for places

The next step is to perform a search with /near-point or /within-extent. To filter and return the best results, you should provide a list of categoriesA place category is a name and ID for a group of related places. There are four levels of place categories. Each category contains a categoryId, fullLabel, and parents (IDs).Learn more and/or keywords when you search. When places are returned, they contain attributesAttributes are fields and values for a single feature or non-spatial record. They are typically stored in a database or service such as a feature service.Learn more such as name, placeId, location, and categories. You can use the place attributes to display them on a map or to get more details about each place.

You can perform the following types of place search with the JavaScript Maps SDK, scripting APIs, or open source libraries. The general steps are to:

Reference the places service.
Set the min and max x and y values for the radius or extent, as well as the categoryIds.
Set the access token.

Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=<LONGITUDE>&y=<LATITUDE>&radius=<METERS>&categoryIds=<IDs>&pageSize=<SIZE>&token=<ACCESS_TOKEN>&f=pjson

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

Expand

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
places.queryPlacesNearPoint({
  point: {
    x: 24.938,
    y: 60.169
  },
  categoryIds: ["4bf58dd8d48988d12d941735", "4bf58dd8d48988d164941735", "4bf58dd8d48988d181941735"],
  radius: 500
}).then(results => {
  console.log(JSON.stringify(results.places, null, 2));
});

Expand

Go to tutorial

REST API

cURL

HTTP

Use dark colors for code blocksCopy
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point' \
-d 'x=24.938' \
-d 'y=60.169' \
-d 'radius=500' \
-d 'categoryIds=4bf58dd8d48988d12d941735,4bf58dd8d48988d164941735,4bf58dd8d48988d163941735' \
-d 'token=<ACCESS_TOKEN>' \
-d 'f=pjson'
Run in Postman

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

{
  "results": [
    {
      "placeId": "22a25084338d14aa48e41a2387880c44",
      "location": {
        "x": -0.128309,
        "y": 51.50718
      },
      "categories": [
        {
          "categoryId": "52e81612bcbc57f1066b7a2e",
          "label": "Sports Club"
        }
      ],
      "name": "News Sports",
      "distance": 50.8
    },
    {
      "placeId": "bdc28ec6bc2246980bd0fd7e569b1976",
      "location": {
        "x": -0.127169,
        "y": 51.507901
      },
      "categories": [
        {
          "categoryId": "52e81612bcbc57f1066b7a2e",
          "label": "Sports Club"
        }
      ],
      "name": "Football INDEX Futures",
      "distance": 73.2
    },
        // more results...
    ],
    "pagination": {
        "nextUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent?xmin=24.89700000&ymin=60.15900000&xmax=24.97900000&ymax=60.17800000&categoryIds=16026,10027,16032&f=pjson&offset=20&pageSize=20"
    }
}

See full response

Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent?xmin=<LONGITUDE>&ymin=<LATITUDE>&xmax=<LONGITUDE>&ymax=<LATITUDE>&categoryIds=<IDs>&pageSize=<SIZE>&token=<ACCESS_TOKEN>&f=pjson

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

Expand

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
places.queryPlacesWithinExtent({
  extent: {
    xmin: 24.897,
    ymin: 60.159,
    xmax: 24.979,
    ymax: 60.178
  },
  categoryIds: ["4bf58dd8d48988d12d941735", "4bf58dd8d48988d181941735", "4bf58dd8d48988d163941735", "4bf58dd8d48988d1e5941735", "4bf58dd8d48988d1e7941735"]
}).then(response => {
  console.log(JSON.stringify(response.results, null, 2));
});

Expand

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocksCopy

curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1//within-extent' \
-d 'xmin=24.897' \
-d 'ymin=60.159' \
-d 'xmax=24.979' \
-d 'ymax=60.178' \
-d 'categoryIds=["4bf58dd8d48988d12d941735", "4bf58dd8d48988d181941735", "4bf58dd8d48988d163941735", "4bf58dd8d48988d1e5941735", "4bf58dd8d48988d1e7941735"]' \
-d 'token=<ACCESS_TOKEN>' \
-d 'f=pjson'
Run in Postman

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

{
"results": [
    {
    "placeId": "f0a1450694ba6d102d164249631f0919",
    "location": {
        "x": 24.929854,
        "y": 60.174766
    },
    "categories": [
        {
        "categoryId": "4bf58dd8d48988d163941735",
        "label": "Park"
        }
    ],
    "name": "Museon puisto"
    },
    {
    "placeId": "6ce75addaa6db1471e0beb51d8e21bc9",
    "location": {
        "x": 24.943898,
        "y": 60.165202
    },
    "categories": [
        {
        "categoryId": "4bf58dd8d48988d163941735",
        "label": "Park"
        },
        {
        "categoryId": "4bf58dd8d48988d164941735",
        "label": "Plaza"
        }
    ],
    // more results...
  ],
    "pagination": {
        "nextUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent?xmin=24.89700000&ymin=60.15900000&xmax=24.97900000&ymax=60.17800000&categoryIds=16026,10027,16032&f=pjson&offset=20&pageSize=20"
    }
}

See full response

3. Get place details

The last step is to request additional place attributes for each placeA place, also known as a point of interest (POI), is a location that represents a business, administrative entity, or geographic feature around the world. A place can also have attributes associated with it, such as a name, address, category, and ID.Learn more by using the /places/{placeId} operation.

To get place details, you need to define the following:

Reference the places service.
Set the place IDA place ID is an unique identifier for a place. You can use the ID with the places service to return additional attribute information such as name, address, description, contact information, website, social links, hours of operation, price ratings, and user ratings.Learn more returned from either a nearby or bounding box search.
Set the requestedFields parameter to specify the fields you want. The request fields are grouped into Place, Address, and/or Details price groups. The number of attributes returned can vary depending on the type of place.
Set the access token.

Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/<placeId>?requestedFields=<place_details>&token=<ACCESS_TOKEN>&f=pjson

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

Expand

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
places.fetchPlace({
  placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
  requestedFields: ["name", "categories"]
})
.then(results => {
  console.log(JSON.stringify(results, null, 2))
})

Expand

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocksCopy

curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/bd5f5dfa788b7c5f59f3bfe2cc3d9c60' \
-d 'requestedFields=name,categories' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>' \
Run in Postman

Use dark colors for code blocksCopy

{
    "placeDetails": {
        "placeId": "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
        "categories": [
            {
                "categoryId": "4bf58dd8d48988d126941735",
                "label": "Government Building"
            },
            {
                "categoryId": "4bf58dd8d48988d12d941735",
                "label": "Monument"
            }
        ],
        "name": "The White House"
    }
}

Additional resources

Tutorials

Find nearby places and details

Find points of interest near a location and get detailed information about them.

JavaScript Maps SDK Leaflet MapLibre GL JS OpenLayers CesiumJS REST JS REST API

Find places in a bounding box

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

Leaflet MapLibre GL JS OpenLayers CesiumJS REST JS REST API