Bounding box search

Search for places in London using a category and/or text filter

What is a bounding box search?

A bounding box search finds places within an extent. An extent typically represents the visible area of a map.

You can use this search to:

Find and display places within a current map extent.
Get the latitude and longitude for places.
Filter places using categories and/or text.
Find place attributes including placeId, name, categories, and location.
Find place IDs so you can request additional place details.

How a bounding box search works

To perform a bounding box search, you use the places service /places/within-extent request and set the xmin, ymin, xmax, and ymax coordinates. The maximum width and height of the search extent is 10,000 meters.

The general steps are:

Get the places service URL.
Set the parameters:
- xmin, xmax, ymin, ymax
- categoryIds, searchText
- pageSize
Execute the request.

Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent?f=json&xmin=-0.01399040222167969&ymin=51.504148054725356&xmax=0.014548301696777345&ymax=51.51579343362533&categoryIds=11000&pageSize=20&token=<ACCESS_TOKEN>

If the number of places in the search area is greater than the pageSize, you can start paging.

The steps to start paging are:

Execute the initial search request (see above).
Use the response to check response.links. If the value is valid, you can page.
Build the next search request:
- Use response.links.base and response.links.next to create the URL.
- The offset parameter is automatically added and incremented for you.
- Add token=<ACCESS_TOKEN> to provide authentication.
Execute the next search request.
Repeat the steps until response.links is null. This indicates no additional results are available.

You can use paging to request up to 200 places.

Use dark colors for code blocksCopy
 https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent?f=json&xmin=-0.01399040222167969&ymin=51.504148054725356&xmax=0.014548301696777345&ymax=51.51579343362533&categoryIds=11000&pageSize=20&offset=20&token=<ACCESS_TOKEN>

URL request

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

Parameters

Name	In	Type	Default value	Description
`xmin`	query	`XCoord`		The minimum x coordinate, or longitude, of the search extent. This is the furthest west that will be searched.
`ymin`	query	`YCoord`		The minimum y coordinate, or latitude, of the search extent. This is the furthest south that will be searched.
`xmax`	query	`XCoord`		The maximum x coordinate, or longitude, of the search extent. This is the furthest east that will be searched.
`ymax`	query	`YCoord`		The maximum y coordinate, or latitude, of the search extent. This is the furthest north that will be searched.
`categoryIds`	query	`array[string]`		Filters places to those that match the category Ids. Places will be returned if they match any of the category Ids. If this property is not set, places will be returned regardless of their category. You can obtain information on category Ids from the `places/categories` endpoint. For example, to filter for places where the category is "Bicycle Store", include the categoryId `17117` in this property. You can search up to a maximum of `10` category Ids.
`searchText`	query	`string`		Free search text for places against names, categories etc.
`pageSize`	query	`integer`	`10`	The number of places that should be sent in the response for a single request. You can set this to any value up to `20` when you need to control the size of responses that your app downloads. If the query results in more than this page size, then the response object will contain a `next` url fragment. This fragment can be used to form a request url to fetch the next page of results. The maximum number of places that can be returned in total is `200`. If a request reaches this limit without returning all of the available places, the response will contain the property `"maxResultsExceeded":true` in addition to place results. The default `pageSize` is 10.
`offset`	query	`integer`		Request results starting from the given offset. This parameter works with the `pageSize` parameter to fetch results from subsequent pages. For example, with a page size of 2, setting the `offset` to `2` would return the 3rd and 4th results. Regardless of paging, the maximum number of places that can be returned by a single query is `200`. When a query results in more than `200` places, the response will contain the property `"maxResultsExceeded":true` in addition to place results.
`f`	query	`string`	`json`	The requested response format - either `json` or `pjson` (pretty json).
`token`	query	`string`		The authentication token with the `premium:user:places` privilege, used to access the Places service. The `token` parameter can be either an API Key or short-lived token. See ArcGIS security documentation for more information on authenticating with a token or API key. Alternatively, you can supply a token in the request header with one of the following keys using the "Bearer" scheme: `Authorization: Bearer <YOUR_TOKEN>` `X-Esri-Authorization: Bearer <YOUR_TOKEN>`

Code examples

Find places by category

In this example, you use specific categories to find places within a map extent for Helsinki. Moving the map will execute a search for the new extent.

The categories are:

Museum (16027)
Park (16032)
Monument (16026)

Steps

Reference the places service.
Set the min and max x and y values for the extent and the categoryIds.
Set the token parameter to your access token.

Find places in specific categories within the current map extent.

APIs

ArcGIS REST JS

Esri Leaflet

MapLibre GL JS

OpenLayers

Expand
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
findPlacesWithinExtent({
  xmin: 24.897,
  ymin: 60.159,
  xmax: 24.979,
  ymax: 60.178,
  categoryIds: ["16026", "10027", "16032"],
  authentication,
}).then(response => {
  console.log(JSON.stringify(response.results, null, 2));
});

Expand

Go to tutorial

REST API

cURL

HTTP

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

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=["16026", "10027", "16032"]' \
-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": "6dcabdbdee17e4d57d64e50fd2bf5b67",
      "location": {
          "x": 24.92331,
          "y": 60.176246
      },
      "categories": [
          {
              "categoryId": "10028",
              "label": "Art Museum"
          }
      ],
      "name": "Reitzin säätiön kokoelmat"
  },
  {
      "placeId": "04db7e0fa56592edcb70a88a0c480fab",
      "location": {
          "x": 24.914545,
          "y": 60.159993
      },
      "categories": [
          {
              "categoryId": "16032",
              "label": "Park"
          }
      ],
      "name": "Selkämerenpuisto"
    },
    // more results...
  ],
  "maxResultsExceeded": false,
    "links": {
        "base": "https://places-api.arcgis.com",
        "next": "/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

Find places by category and text

In this example, you use the categoryIds and searchText parameters to find places that are within the map extent for area in London. Moving the map will execute a search for the new extent.

The categories are:

Pub (13018)
Fish and Chips Shop (13051)
Sports Club (18065)

Steps

Reference the places service.
Define the extent for the search and set the categoryIds and searchText parameters with the keywords.
Set the token parameter to your access token.

Find places based on search text.

APIs

ArcGIS REST JS

Esri Leaflet

MapLibre GL JS

OpenLayers

Expand
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
findPlacesWithinExtent({
  xmin: -0.107,
  ymin: 51.513,
  xmax: -0.148,
  ymax: 51.502,
  searchText: "sports",
  categoryIds: ["13018", "13051", "18065"],
  authentication,
}).then(response => {
  console.log(JSON.stringify(response.results, null, 2));
});

Expand

Go to API reference

REST API

cURL

HTTP

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
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1//within-extent' \
-d 'xmin=-0.107' \
-d 'ymin=51.513' \
-d 'xmax=-0.148' \
-d 'ymax=51.502' \
-d 'searchText="sports"' \
-d 'categoryIds=["13018", "13051", "18065"]' \
-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.12833,
              "y": 51.50711
          },
          "categories": [
              {
                  "categoryId": "18065",
                  "label": "Sports Club"
              }
          ],
          "name": "News Sports"
      },
      {
          "placeId": "c37f9d7946964078b530d2c7eeb64d2f",
          "location": {
              "x": -0.126172,
              "y": 51.507999
          },
          "categories": [
              {
                  "categoryId": "18065",
                  "label": "Sports Club"
              }
          ],
          "name": "Social Media"
      },
      // more results...
  ],
  "maxResultsExceeded": false
}

See full response

Page through results

This example searches for all places without using categories for an extent near Seattle. Moving the map will execute a search for the new extent.

If there are more results than the pageSize, you can page through them using the next URL in the links attribute. The maximum number of places that you can page through is 200.

Steps

Reference the places service.
Define the extent for the search.
Set the token parameter to your access token.
Using ArcGIS REST JS, if repsponse.nextPage is valid, use the nextPage() to send the next request.

Return 200 places by paging through result response.

APIs

ArcGIS REST JSArcGIS REST JSEsri LeafletMapLibre GL JSOpenLayers
Expand
Use dark colors for code blocksCopy
const getPlaces = async () => {
  let places = await arcgisRest.findPlacesWithinExtent({
    xmin: -122.322,
    ymin: 47.609,
    xmax: -122.342,
    ymax: 47.603,
    authentication,
  });

  console.log(JSON.stringify(lastResponse.results, null, 2));

  while (lastResponse.nextPage) {
    try {
      lastResponse = await lastResponse.nextPage();
      console.log(JSON.stringify(lastResponse.results, null, 2));
    } catch {
      break;
    }
  }
};
getPlaces();

REST API

cURL

HTTP

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
## initial request
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent' \
-d 'xmin=-122.322' \
-d 'ymin=47.609' \
-d 'xmax=-122.342' \
-d 'ymax=47.603' \
-d 'pageSize=20' \
-d 'token=<ACCESS_TOKEN>' \
-d 'f=pjson'

## next request
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/within-extent' \
-d 'xmin=-122.322' \
-d 'ymin=47.609' \
-d 'xmax=-122.342' \
-d 'ymax=47.603' \
-d 'offset=40' \
-d 'pageSize=20' \
-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
// initial request
{
  "results":["<results array>"]
  "maxResultsExceeded": true,
  "links": {
    "base": "https://places-api.arcgis.com",
    "next": "/arcgis/rest/services/places-service/v1/places/within-extent?xmin=-122.32164860&ymin=47.60912875&xmax=-122.34233379&ymax=47.60286441&f=pjson&offset=20&pageSize=20"
  }
}

// next request
{
  "results":["<results array>"]
  "maxResultsExceeded": true,
  "links": {
    "base": "https://places-api.arcgis.com",
    "previous": "/arcgis/rest/services/places-service/v1/places/within-extent?xmin=-122.32164860&ymin=47.60912875&xmax=-122.34233379&ymax=47.60286441&f=pjson&offset=0&pageSize=20",
    "next": "/arcgis/rest/services/places-service/v1/places/within-extent?xmin=-122.32164860&ymin=47.60912875&xmax=-122.34233379&ymax=47.60286441&f=pjson&offset=40&pageSize=20"
  }
}

See full initial response See full next response

Tutorials

Find places in a bounding box

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

Services

Places service (Beta)

Find and get details about businesses, places, and other POI.

API support

	Category search	Nearby search	Boundary search	Place details
ArcGIS Maps SDK for JavaScript	¹	¹	¹	¹
ArcGIS Maps SDK for .NET
ArcGIS Maps SDK for Kotlin
ArcGIS Maps SDK for Swift
ArcGIS Maps SDK for Java
ArcGIS Maps SDK for Qt
ArcGIS API for Python
ArcGIS REST JS
Esri Leaflet	¹	¹	¹	¹
MapLibre GL JS	¹	¹	¹	¹
OpenLayers	¹	¹	¹	¹
CesiumJS	¹	¹	¹	¹

Full supportPartial supportNo support

1. Access via ArcGIS REST JS.

Tools

Places category finder

Find and select categories to create a JSON array of IDs.

Mapping APIs and location services

Bounding box search

Was this page helpful?

Was this page helpful?