/places/{placeId} | Esri Developer REST APIs documentation

GET
Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/{placeId}

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

The /places/{placeId} request returns details for a place.

To request details, you use the requestedFields parameter to specify the fields and the attributes you want from the Place, Address, Details and/or Location price groups.

It is always recommended to specify the fields you want, however, you can also use requestedFields=all to return all of the attributes available. By default, The placeId attribute is always returned in addition to the other attributes you requested.

The attributes available for places may vary. For example, opening hours may not be available (or applicable) for geographic places or landmarks.

You will only be charged for attributes that contain valid values for the requested fields. If no data is available for the requested field, null or an empty collection is returned and you are not charged. You are only charged once if one or more attributes with valid values are returned from a price group. To learn more, go to Pricing.

Field	Price group
additionalLocations:dropOff	Location
additionalLocations:frontDoor	Location
additionalLocations:road	Location
additionalLocations:roof	Location
address:adminRegion	Address
address:censusBlockId	Address
address:country	Address
address:designatedMarketArea	Address
address:extended	Address
address:locality	Address
address:neighborhood	Address
address:poBox	Address
address:postcode	Address
address:postTown	Address
address:region	Address
address:streetAddress	Address
categories	Place
chains	Details
contactInfo:email	Details
contactInfo:fax	Details
contactInfo:telephone	Details
contactInfo:website	Details
description	Details
hours:opening	Details
hours:openingText	Details
hours:popular	Details
location	Location
name	Place
rating:price	Details
rating:user	Details
socialMedia:facebookId	Details
socialMedia:instagram	Details
socialMedia:twitter	Details

Note: Due to limitations with the underlying data source, the following fields will currently return null:

Field	Price group
address:censusBlockId	Address
address:designatedMarketArea	Address
address:extended	Address
address:neighborhood	Address
additionalLocations:*	Location
chains	Details
contactInfo:fax	Details
description	Details
hours:*	Details
rating:*	Details

Note: You cannot permanently store places. Please see the Terms of use.

Note: Query parameters are case-sensitive.

Note: Can be used in conjunction with the Basemap Styles service to request additional attributes for places retrieved using the Places for basemaps workflow.

Query parameters

Name	Type	Default value	Description
`requestedFields`	`[string]`		The array of fields that define the attributes to return for a place.
`icon`	`string`	`none`	Determines whether icons are returned and the type of icon to use with a place or category.
`f`	`string`	`json`	The requested response format - either `json` or `pjson` (pretty json).
`token`	`string`		The authentication token, used to access the places service.

requestedFields

The array of fields that define the attributes to return for a place.

Use this parameter to define the attributes you would like returned, for example requestedFields=name,address:streetAddress. However, you can also set this value to requestedFields=all to return all of the attributes available for a place.

The placeId attribute is always returned in addition to the other attributes you requested. If a valid attribute value is not available, null, or an empty collection, is returned and you are not charged for it. To see the fields and pricing groups they belong to, go to the table above.

icon

Determines whether icons are returned and the type of icon to use with a place or category.

example icon

Use this parameter to define the type of icon URL for a given place or category. Place icons are available in the following formats:

svg
cim (Cartographic Information Model)
png 48 x 48 pixels

The SVG and CIM symbols default to 15 x 15 pixels but can be scaled smoothly for display in larger UI elements or to emphasize these features on a map. The PNG icons are provided as 48 x 48 pixels but for map display the recommended size is 16 x 16 pixels.

The default is none (no icon URL will be returned).

Default: none

Enumerated values

none

Click to copy

svg

Click to copy

png

Click to copy

cim

Click to copy

f

The requested response format - either json or pjson (pretty json).

Default: json

Enumerated values

json

Click to copy

pjson

Click to copy

token

The authentication token, used to access the places service.

The token parameter can be either an API Key or short-lived token.

This parameter is required unless you supply an access 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>

The provided token must be created from an ArcGIS Location Platform account and have the necessary premium:user:places privilege to use the places service.

Developer guide: To learn more, go to Security and authentication.

Path parameters

Name	Type	Required	Description
`placeId`	`PlaceId`		The Id of the place for which you want to fetch additional details.

placeId

The Id of the place for which you want to fetch additional details.

Minimum length: 32
Maximum length: 32

Response status

Status	Meaning	Description	Schema
200	OK	A successful response for a `places/{placeId}` request.	inline
400	Bad Request	Invalid query parameters.	Error
401	Unauthorized	Authentication Error. The API key or token is missing, invalid or expired.	Error
403	Forbidden	The required parameter 'token' is valid but does not have permission to access the service.	Error
404	Not Found	A resource with the supplied Id was not found.	Error
5XX	Server Error	An error occurred on the server.	Error

Response details

Status Code 200

Name Type Required Description

Name	Type	Required	Description
`placeDetails`	`PlaceDetails`		The additional details for a `Place`, including address, contact details, opening hours, and rating. You can request additional details for a place by using the `placeId` in a `places/{placeId}` request. Use the `requestedFields` query parameter to choose the fields or attributes that are included in the response.

placeDetails

PlaceDetails

The additional details for a Place, including address, contact details, opening hours, and rating.

You can request additional details for a place by using the placeId in a places/{placeId} request. Use the requestedFields query parameter to choose the fields or attributes that are included in the response.

Examples

Request

Use dark colors for code blocksCopy
# You can also use wget
curl -X GET https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/2880ba4b89db36eb3470e4c557f81a5c?requestedFields=address \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

Response

Use dark colors for code blocksCopy
{
  "placeDetails": {
    "placeId": "2880ba4b89db36eb3470e4c557f81a5c",
    "categories": [
      {
        "categoryId": "4bf58dd8d48988d124941735",
        "label": "Office"
      }
    ],
    "name": "Esri Building N",
    "location": {
      "x": -117.194769,
      "y": 34.057289
    },
    "description": {},
    "address": {
      "streetAddress": "380 New York St",
      "extended": {},
      "locality": "Redlands",
      "designatedMarketArea": "Los Angeles",
      "region": "CA",
      "postcode": 92373,
      "poBox": {},
      "country": "US",
      "adminRegion": {},
      "postTown": {},
      "neighborhood": [],
      "censusBlockId": {}
    },
    "additionalLocations": {
      "dropOff": {},
      "frontDoor": {},
      "road": {},
      "roof": {}
    },
    "contactInfo": {
      "telephone": {},
      "website": {},
      "fax": {},
      "email": {}
    },
    "socialMedia": {
      "facebookId": {},
      "twitter": {},
      "instagram": {}
    },
    "hours": {
      "opening": {},
      "popular": {},
      "openingText": {}
    },
    "rating": {
      "price": {},
      "user": {}
    },
    "chains": []
  }
}