findPlacesNearPoint
FunctionfindPlacesNearPoint(requestOptions: IFindPlacesNearPointOptions): Promise<IFindPlacesNearPointResponse>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 getPlaceDetails 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
getCategoryorgetCategories. - A partial name filter with
nameoption
As this request can return many results, pagination is supported.
When a query results in more than [pageSize] places, the response will contain the property
pagination in addition to place results. If pagination exists, an additional method
response.nextPage() can be used to get the next page of results.
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);Parameters
| Parameter | Type |
|---|---|
request | IFindPlacesNearPointOptions |
Returns
Promise<IFindPlacesNearPointResponse>