Get place details including name, address, description, and other attributes.
The /places/{place
request returns details for a place.
To request details, you use the requested
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 requested
to return all of the attributes
available. By default, The place
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: 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 | Required | Default value | Description |
---|---|---|---|---|
|
| The array of fields that define the attributes to return for a place. | ||
|
| Determines whether icons are returned and the type of icon to use with a place or category. | ||
|
| The requested response format - either | ||
|
| The authentication token, created from an ArcGIS Location Platform account, with the |
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 requested
. However, you can also
set this value to requested
to return all of the attributes available
for a place.
The place
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.
Enumerated values
icon
Determines whether icons are returned and the type of icon to use with a place or category.
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
f
The requested response format - either json
or pjson
(pretty json).
- Default
- json
Enumerated values
token
The authentication token, created from an ArcGIS Location Platform account, with the premium
privilege, used to access the Places service.
The token
parameter can be either an API Key or short-lived token. See
ArcGIS security
documentation
for more information on authenticating with a token or API key.
Alternatively, you can supply a 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 >
Path parameters
Name | Type | Required | Default value | Description |
---|---|---|---|---|
| The Id of the place for which you want to fetch additional details. |
Examples
Request
# You can also use wget
curl -X GET https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/{placeId}?requestedFields=all \
-H 'Accept: application/json'
Response
A successful response for a
places/{place
request.Id}
{
"placeDetails": {
"placeId": "2da082218b6f7538e52250999c8f8ef1",
"categories": [
{
"categoryId": "11167",
"label": "Technology Business"
}
],
"name": "Esri",
"location": {
"x": -117.194769,
"y": 34.057289
},
"description": "Esri is the global market leader in geographic information system\n(GIS) technology, location intelligence, mapping software, and\nspatial analytics. Esri software is deployed in more than 350,000\norganizations and 75 percent of Fortune 500 companies.\n",
"address": {
"streetAddress": "380 New York St",
"extended": "Unit 32",
"locality": "Redlands",
"designatedMarketArea": "Los Angeles",
"region": "CA",
"postcode": 92373,
"poBox": null,
"country": "US",
"adminRegion": null,
"postTown": null,
"neighborhood": [],
"censusBlockId": "060710081003002"
},
"additionalLocations": {
"dropOff": null,
"frontDoor": null,
"road": null,
"roof": null
},
"contactInfo": {
"telephone": "(909) 793-2853",
"website": "https://www.esri.com",
"fax": "(909) 793-5953",
"email": "support@esri.com"
},
"socialMedia": {
"facebookId": 183768242996,
"twitter": "esri",
"instagram": "esrigram"
},
"hours": {
"opening": {
"monday": [
{
"from": "08:00",
"to": "17:00"
}
],
"tuesday": [
{
"from": "08:00",
"to": "17:00"
}
],
"wednesday": [
{
"from": "08:00",
"to": "17:00"
}
],
"thursday": [
{
"from": "09:00",
"to": "17:00"
}
],
"friday": [
{
"from": "09:00",
"to": "17:30"
}
]
},
"popular": {
"monday": [
{
"from": "06:00",
"to": "14:00"
},
{
"from": "16:00",
"to": "17:00"
}
],
"tuesday": [
{
"from": "07:00",
"to": "14:00"
},
{
"from": "16:00",
"to": "18:00"
}
],
"wednesday": [
{
"from": "06:00",
"to": "17:00"
}
],
"thursday": [
{
"from": "07:00",
"to": "17:00"
}
],
"friday": [
{
"from": "07:00",
"to": "14:00"
},
{
"from": "16:00",
"to": "18:00"
}
]
},
"openingText": "Mon-Fri 8:00 AM-5:00 PM",
"rating": {
"price": null,
"user": null
},
"chains": []
}
}
}
400 Response
{
"error": {
"code": 400,
"message": "Parameter invalid.",
"details": [
"string"
],
"restInfoUrl": "https://places-api.arcgis.com/arcgis/rest/info"
}
}
Status | Meaning | Description | Schema |
---|---|---|---|
| A successful response for a | Inline | |
| Invalid query parameters. | ||
| Authentication Error. The API key or token is missing, invalid or expired. | ||
| The required parameter 'token' is valid but does not have permission to access the service. | ||
| A resource with the supplied Id was not found. | ||
| Unknown | An error occurred on the server. |
Response details
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
| none | The additional details for a You can request additional details for a place by using the | ||
| none | The unique Id of this place. | ||
|
| none | A list of category objects for a place. Categories are uniquely identified by a This property is part of the "Place" attribute group. | |
| none | The category Id uniquely identifies this category or type of place. The name of the category can be looked up using the
| ||
|
| none | The label that describes the category. | |
|
| none | The name of the place, or point of interest. This property is part of the "Place" attribute group. | |
| none | A point defined in WGS84 decimal degrees. | ||
|
| none | An x-coordinate, or longitude, in WGS84 decimal degrees. | |
|
| none | A y-coordinate, or latitude, in WGS84 decimal degrees. | |
|
| none | A text description of the place. This property is part of the "Details" attribute group. | |
| none | The address of a place, or point of interest (POI). | ||
|
| none | The street address for a place, for example the street name and number. | |
|
| none | Additional address information, including suite or apartment numbers. | |
|
| none | The city, town, or equivalent. | |
|
| none | As defined by Nielsen, signifies a region where the population can receive similar TV and radio offerings (US only). | |
|
| none | The state, province, territory or equivalent. | |
|
| none | Postal code or equivalent (zip code in the US). Format will be localized based on country. | |
|
| none | Post-office box. | |
|
| none | Two letter ISO country code | |
|
| none | Additional sub-division. Usually, but not always, a country sub-division (e.g., Scotland). | |
|
| none | Town/place employed in postal addressing. | |
|
| none | The neighborhoods of the place. | |
|
| none | The census block Id of the place (US only). | |
| none | A set of additional locations for the place, as WGS84 points. This list provides alternative locations for accessing a place such as
| ||
|
| none | A point defined in WGS84 decimal degrees. | |
|
| none | An x-coordinate, or longitude, in WGS84 decimal degrees. | |
|
| none | A y-coordinate, or latitude, in WGS84 decimal degrees. | |
|
| none | A point defined in WGS84 decimal degrees. | |
|
| none | A point defined in WGS84 decimal degrees. | |
|
| none | A point defined in WGS84 decimal degrees. | |
| none | The contact information for a place. | ||
|
| none | The telephone number of the place. | |
|
| none | The website address of the place. | |
|
| none | Fax number. | |
|
| none | Email address. | |
| none | The social media details for a place. | ||
|
| none | The facebook Id of the place. | |
|
| none | The twitter handle of the place. | |
|
| none | The instagram ID of the place. | |
| none | Lists the opening hours of this place or POI along with the popular or busy hours. A string is also provided that can be used for display. | ||
|
| none | The opening or popular hours for a place. Opening hours are shown by day of the week. Each day can have several pairs of from and to times. For example, if a coffee shop is open from 9:00 until 12:00 and then again from 13:00 until 17:00, it would contain two pairs of opening/closing times: 9:00 paired with 12:00 and 13:00 with 17:00. Hours are shown in 24-hour time in the local timezone of the place or POI. | |
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
|
| none | The start of a time range in the format "HH:MM". | |
|
| none | The end of a time range in the format "HH:MM". | |
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
| none | A pair of times defining the start and end of a time period. For example, this could define opening hours or popular hours. Hours are shown in 24-hour time in the local timezone of the place or POI. Where a time range is 24-hours (for example a venue that is open 24-hours),
the | ||
|
| none | The opening or popular hours for a place. Opening hours are shown by day of the week. Each day can have several pairs of from and to times. For example, if a coffee shop is open from 9:00 until 12:00 and then again from 13:00 until 17:00, it would contain two pairs of opening/closing times: 9:00 paired with 12:00 and 13:00 with 17:00. Hours are shown in 24-hour time in the local timezone of the place or POI. | |
|
| none | The opening hours for this place, formatted for display. | |
| none | Rating information about the price and user rating of the place. | ||
|
| none | An indication of the overall price of a place based on user reviews. | |
|
| none | A rating for the place based on user-reviews from 0 to 5, where 5 is the best rating. | |
| none | Information about all the chains the place belongs to. This object and child properties are part of the "Details" attribute group. | ||
|
| none | The name of the chain. | |
| none | Details of an icon, suitable for depicting this place. To fetch icon details use the | ||
|
| none | Url for an icon for this place or category in either |