Nearby search | Documentation

Search for places in New York using a category, text filter, and radius

What is a nearby search?

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

You can use this search to:

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

How to perform a nearby search

To perform a nearby search, you use the places service /places/near-point request and set the x and y coordinates and the radius in meters that you would like to search. The default radius is 1,000 meters and the maximum value is 10,000 meters.

The general steps are:

Get the places service URL.
Set the parameters:
- x, y
- radius
- categoryIds, searchText
- pageSize
Execute the request.

Use dark colors for code blocksCopy
 https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?f=json&x=-74.006792&y=40.711646&radius=450&categoryIds=63be6904847c3692a84b9bb5&pageSize=20&searchText=bar&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/near-point?f=json&x=-74.006792&y=40.711646&radius=450&categoryIds=63be6904847c3692a84b9bb5&pageSize=20&offset=20&searchText=bar&token=<ACCESS_TOKEN>

URL request

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

Parameters

Name	In	Type	Default value	Description
`x`	query	`XCoord`		The x coordinate, or longitude, to search from, in WGS84 decimal degrees.
`y`	query	`YCoord`		The y coordinate, or latitude, to search from, in WGS84 decimal degrees.
`radius`	query	`SearchDistance`	`1000`	The radius in meters to search for places - measured from the supplied `x` and `y` coordinate.
`categoryIds`	query	`array[string]`		Filters places to those that match the 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.
`icon`	query	`string`	`none`	Determines whether icons are returned and the type of icon to use with a place or category.
`offset`	query	`integer`	`0`	Request results starting from the given offset.
`f`	query	`string`	`json`	The requested response format - either `json` or `pjson` (pretty json).
`token`	query	`string`		<!--snippet token_query_param SERVICE="places" PRIV="premium:user:places" -->

Code examples

Find places by category

In this example, you use specific categories to find places within a location near Helsinki within a 500 meter radius. Clicking on the map will execute a new search.

The categories are:

Museum (4bf58dd8d48988d181941735)
Park (4bf58dd8d48988d163941735)
Monument (4bf58dd8d48988d12d941735)

Steps

Reference the places service.
Define the x and y coordinates, categoryIds, and radius.
Set the token parameter to your access token.

Find places in specific categories within a 500 meter search radius.

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

Find places by category and text

In this example, you use the categoryIds and searchText parameters to find places that are within 1609 meters of a location in London. Clicking on the map will execute a new search.

The categories are:

Pub (4bf58dd8d48988d11b941735)
Fish and Chips Shop (4edd64a0c7ddd24ca188df1a)
Sports Club (52e81612bcbc57f1066b7a2e)

Steps

Reference the places service.
Define the x and y coordinates, categoryIds, and the searchText parameters.
Set the token parameter to your access token.

Filter results from specific categories using a text search

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: -0.1276,
    y: 51.5073
  },
  searchText: "sports",
  radius: 1609.344,
  categoryIds: ["4bf58dd8d48988d11b941735", "4edd64a0c7ddd24ca188df1a", "52e81612bcbc57f1066b7a2e"]
}).then(results => {
  console.log(JSON.stringify(results.places, 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/near-point' \
-d 'x=-0.1276' \
-d 'y=51.5073' \
-d 'searchText=sports' \
-d 'radius = 1609.344' \
-d 'categoryIds=4bf58dd8d48988d11b941735,4edd64a0c7ddd24ca188df1a,52e81612bcbc57f1066b7a2e' \
-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": "628d6995be9f7104820257cd6ca62c19",
          "location": {
              "x": -3.18845,
              "y": 55.953476
          },
          "categories": [
              {
                  "categoryId": "4bf58dd8d48988d16d941735",
                  "label": "Cafe"
              }
          ],
          "name": "Rabbie's",
          "distance": 21.7
      },
      {
          "placeId": "aaeb463df3d9c9791ff86cdf6a630272",
          "location": {
              "x": -3.188639,
              "y": 55.953645
          },
          "categories": [
              {
                  "categoryId": "4bf58dd8d48988d16d941735",
                  "label": "Cafe"
              }
          ],
          "name": "Noon",
          "distance": 43.8
      },
        // more results...
    ],
    "pagination": {
        "nextUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=-3.18830000&y=55.95330000&searchText=tea&f=pjson&offset=10&pageSize=10"
    }
}

See full response

Page through results

This example searches for all places without using categories within 250 m of a location in Wellington. Clicking on the map will execute a new search.

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 x and y coordinates for the search.
Set the token parameter to your access token.
Using ArcGIS REST JS, if response.nextPage is valid, use the nextPage() to send the next request.

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

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
const getPlaces = async () => {
  let lastResponse = await places.queryPlacesNearPoint({
    point: {
      x: 174.778,
      y: -41.292
    },
    radius: 250
  });

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

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocksCopy
## initial request
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point' \
-d 'x=174.778' \
-d 'y=-41.292' \
-d 'radius=250' \
-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/near-point' \
-d 'x=174.778' \
-d 'y=-41.292' \
-d 'radius=250' \
-d 'pageSize=20' \
-d 'offset=40' \
-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...",
    "pagination": {
        "nextUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=174.77800000&y=-41.29200000&f=pjson&offset=20&pageSize=20"
    }
}

// next request
{
    "results":["results..."],
    "pagination": {
        "previousUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=174.77800000&y=-41.29200000&f=pjson&offset=0&pageSize=20",
        "nextUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=174.77800000&y=-41.29200000&f=pjson&offset=40&pageSize=20"
    }
}

See full initial response See full next response

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