findPlacesNearPoint

Searches places that are within a given radius of a geographic point. You must supply the x and y coordinates of the point that you wish to search from. You can either specify a search radius, or use the default (500 meters). You could use this method to search for places around a user's GPS position, or a location clicked on a map.

The returned places contain basic data such as name, category and location. You can use the getPlace method to get additional details for a given place.

You can refine the results by supplying additional search parameters, including:

• A list of category Ids, see searchCategories or getCategories.
• A partial name filter with name option

As this request can return many results, pagination is supported. 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 200places, the response will contain the property"maxResultsExceeded":true in addition to place results. If maxResultsExceededis true an additional method response.nextPage() can be used to get the next page of results.

1
2
3
4
5
6
7
8
9
10
11
import { findPlacesNearPoint } from "@esri/arcgis-rest-places";
import { ApiKeyManager } from "@esri/arcgis-rest-request";

const response = await findPlacesNearPoint({
  x: -3.1883,
  y: 55.9533,
  radius: 100,
  authentication: ApiKeyManager.fromKey("YOUR_API_KEY");
});

console.log(response);

Returns