places

Method Overview

Method Details

fetchPlace(params, requestOptions){Promise<object>}

Get place details, including name, address, description, and other attributes.

Parameters

params FetchPlaceParameters Defines the parameters of the place details request.

requestOptions Object optional Additional options to be used for the data request.

Returns

Type	Description
Promise<object>	Returns a promise that resolves to an object with the results.

See also

• FetchPlaceParameters

Example

require([
 "esri/rest/places",
 "esri/rest/support/FetchPlaceParameters"
], function(places, FetchPlaceParameters) {
   const swedishFetchPlaceParameters = new FetchPlaceParameters({
     apiKey: "YOUR_API_KEY",
     placeId: "571624acd79b8a99897357a25b744a20",  // really good plumber
     requestedFields: ["address", "description", "hours", "socialMedia"]
   });

   function fetchPlaceDetails() {
     places.fetchPlace(swedishFetchPlaceParameters).then(showPlaceDetails);
   }

   function showPlaceDetails(fetchResult) {
     console.log("Fetch place result: ", fetchResult);
   }

   fetchPlaceDetails();
});

queryPlacesNearPoint(params, requestOptions){Promise<PlacesQueryResult>}

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

Parameters

params PlacesQueryParameters Defines the parameters of the query request.

requestOptions Object optional Additional options to be used for the data request.

Returns

Type	Description
Promise<PlacesQueryResult>	Resolves to an object containing the PlacesQueryResult as a promise.

See also

• PlacesQueryParameters
• PlacesQueryResult

Example

require([
 "esri/rest/places",
 "esri/rest/support/PlacesQueryParameters"
], function(places, PlacesQueryParameters) {
   const point = {
     type: "point", // autocasts as new Point()
     longitude: 17.81840,
     latitude: 59.42145
   };

   const swedishPlacesQueryParameters = new PlacesQueryParameters({
     apiKey: "YOUR_API_KEY",
     categoryIds: ["11077"], // Bathroom Contractor
     radius: 10000,  // set radius to 10,000 meters
     point
   });

   function findPlaces() {
     places.queryPlacesNearPoint(swedishPlacesQueryParameters).then(showPlaces);
   }

   function showPlaces(placesSolveResult) {
     // results from the queryPlacesNearPoint() method
     console.log("PlacesQueryResult: ", placesSolveResult);
     // first PlaceResult object from PlacesQueryResult.results
     console.log("PlaceResult: ", placesSolveResult.results[0]);
   }

   findPlaces();
});

queryPlacesWithinExtent(params, requestOptions){Promise<PlacesQueryResult>}

A search that finds places within a given extent. An extent typically represents the visible area of a map.

Parameters

params PlacesQueryParameters Defines the parameters of the query request.

requestOptions Object optional Additional options to be used for the data request.

Returns

Type	Description
Promise<PlacesQueryResult>	Resolves to an object containing the PlacesQueryResult as a promise.

See also

• PlacesQueryParameters
• PlacesQueryResult

Example

require([
 "esri/rest/places",
 "esri/rest/support/PlacesQueryParameters",
 "esri/geometry/Extent"
], function(places, PlacesQueryParameters, Extent) {
   const extent = new Extent({
     xmin: 17.75,
     ymin: 59.55,
     xmax: 18,
     ymax: 59.7,
     spatialReference: 4326
   });

   const swedishPlacesQueryParameters = new PlacesQueryParameters({
     apiKey: "YOUR_API_KEY",
     categoryIds: ["16000"], // Landmarks and Outdoors
     extent
   });

   function findPlaces() {
     places.queryPlacesWithinExtent(swedishPlacesQueryParameters).then(showPlaces);
   }

   function showPlaces(placesSolveResult) {
     // results from the queryPlacesWithinExtent() method
     console.log("PlacesQueryResult: ", placesSolveResult);
     // first PlaceResult object from PlacesQueryResult.results
     console.log("PlaceResult: ", placesSolveResult.results[0]);
   }

   findPlaces();
});