/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.

FieldPrice group
additionalLocations:dropOffLocation
additionalLocations:frontDoorLocation
additionalLocations:roadLocation
additionalLocations:roofLocation
address:adminRegionAddress
address:censusBlockIdAddress
address:countryAddress
address:designatedMarketAreaAddress
address:extendedAddress
address:localityAddress
address:neighborhoodAddress
address:poBoxAddress
address:postcodeAddress
address:postTownAddress
address:regionAddress
address:streetAddressAddress
categoriesPlace
chainsDetails
contactInfo:emailDetails
contactInfo:faxDetails
contactInfo:telephoneDetails
contactInfo:websiteDetails
descriptionDetails
hours:openingDetails
hours:openingTextDetails
hours:popularDetails
locationLocation
namePlace
rating:priceDetails
rating:userDetails
socialMedia:facebookIdDetails
socialMedia:instagramDetails
socialMedia:twitterDetails

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

FieldPrice group
address:censusBlockIdAddress
address:designatedMarketAreaAddress
address:extendedAddress
address:neighborhoodAddress
additionalLocations:*Location
chainsDetails
contactInfo:faxDetails
descriptionDetails
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

NameTypeRequiredDefault valueDescription

array[string]

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

string

none

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

string

json

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

string

The authentication token, created from an ArcGIS Location Platform account, with the premium:user:places privilege, 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.

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

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:

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
svg
png
cim

f

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

Default
json
Enumerated values
json
pjson

token

The authentication token, created from an ArcGIS Location Platform account, with the premium:user:places 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

NameTypeRequiredDefault valueDescription

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.

Examples

Request

1
2
3
# 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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
  "placeDetails": {
    "placeId": "2880ba4b89db36eb3470e4c557f81a5c",
    "categories": [
      {
        "categoryId": "4bf58dd8d48988d124941735",
        "label": "Office"
      }
    ],
    "name": "Esri Building N",
    "location": {
      "x": -117.194769,
      "y": 34.057289
    },
    "description": null,
    "address": {
      "streetAddress": "380 New York St",
      "extended": null,
      "locality": "Redlands",
      "designatedMarketArea": "Los Angeles",
      "region": "CA",
      "postcode": 92373,
      "poBox": null,
      "country": "US",
      "adminRegion": null,
      "postTown": null,
      "neighborhood": [],
      "censusBlockId": null
    },
    "additionalLocations": {
      "dropOff": null,
      "frontDoor": null,
      "road": null,
      "roof": null
    },
    "contactInfo": {
      "telephone": null,
      "website": null,
      "fax": null,
      "email": null
    },
    "socialMedia": {
      "facebookId": null,
      "twitter": null,
      "instagram": null
    },
    "hours": {
      "opening": null,
      "popular": null,
      "openingText": null
    },
    "rating": {
      "price": null,
      "user": null
    },
    "chains": []
  }
}
StatusMeaningDescriptionSchema

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

Unknown

An error occurred on the server.

Error

Response details

Status Code 200

NameTypeRequiredRestrictionsDescription

placeDetails

none

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.

placeId

none

The unique Id of this place.

categories

none

A list of category objects for a place.

Categories are uniquely identified by a categoryId. For example, 4bf58dd8d48988d115951735 identifies a "Bicycle Store" and 4bf58dd8d48988d184941735 identifies a "Stadium". Note that a single place can belong to multiple categories (for example, a petrol station could also have a super-market).

This property is part of the "Place" attribute group.

categoryId

none

The category Id uniquely identifies this category or type of place.

The name of the category can be looked up using the places/categories endpoint. For example, "4bf58dd8d48988d115951735" is the id for a "Bicycle Store".

label

string

none

The label that describes the category.

name

string

none

The name of the place, or point of interest.

This property is part of the "Place" attribute group.

location

none

A point defined in WGS84 decimal degrees.

x

XCoord(double)

none

An x-coordinate, or longitude, in WGS84 decimal degrees.

y

YCoord(double)

none

A y-coordinate, or latitude, in WGS84 decimal degrees.

description

string¦null

none

A text description of the place.

This property is part of the "Details" attribute group.

address

none

The address of a place, or point of interest (POI).

streetAddress

string¦null

none

The street address for a place, for example the street name and number.

extended

string¦null

none

Additional address information, including suite or apartment numbers.

locality

string¦null

none

The city, town, or equivalent.

designatedMarketArea

string¦null

none

As defined by Nielsen, signifies a region where the population can receive similar TV and radio offerings (US only).

region

string¦null

none

The state, province, territory or equivalent.

postcode

string¦null

none

Postal code or equivalent (zip code in the US).

Format will be localized based on country.

poBox

string¦null

none

Post-office box.

country

string¦null

none

Two letter ISO country code

adminRegion

string¦null

none

Additional sub-division.

Usually, but not always, a country sub-division (e.g., Scotland).

postTown

string¦null

none

Town/place employed in postal addressing.

neighborhood

[string]

none

The neighborhoods of the place.

censusBlockId

string¦null

none

The census block Id of the place (US only).

additionalLocations

none

A set of additional locations for the place, as WGS84 points.

This list provides alternative locations for accessing a place such as frontDoor or road.

dropOff

none

A point defined in WGS84 decimal degrees.

x

XCoord(double)

none

An x-coordinate, or longitude, in WGS84 decimal degrees.

y

YCoord(double)

none

A y-coordinate, or latitude, in WGS84 decimal degrees.

frontDoor

none

A point defined in WGS84 decimal degrees.

road

none

A point defined in WGS84 decimal degrees.

roof

none

A point defined in WGS84 decimal degrees.

contactInfo

none

The contact information for a place.

telephone

string¦null

none

The telephone number of the place.

website

string(url)¦null

none

The website address of the place.

fax

string¦null

none

Fax number.

email

string¦null

none

Email address.

socialMedia

none

The social media details for a place.

facebookId

string¦null

none

The facebook Id of the place.

twitter

string¦null

none

The twitter handle of the place.

instagram

string¦null

none

The instagram ID of the place.

hours

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.

opening

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.

monday

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 from property will be 00:00 and the to property will be 23:59.

from

string

none

The start of a time range in the format "HH:MM".

to

string

none

The end of a time range in the format "HH:MM".

tuesday

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 from property will be 00:00 and the to property will be 23:59.

wednesday

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 from property will be 00:00 and the to property will be 23:59.

thursday

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 from property will be 00:00 and the to property will be 23:59.

friday

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 from property will be 00:00 and the to property will be 23:59.

saturday

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 from property will be 00:00 and the to property will be 23:59.

sunday

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 from property will be 00:00 and the to property will be 23:59.

popular

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.

openingText

string¦null

none

The opening hours for this place, formatted for display.

rating

none

Rating information about the price and user rating of the place.

price

string¦null

none

An indication of the overall price of a place based on user reviews.

user

number(float)¦null

none

A rating for the place based on user-reviews from 0 to 5, where 5 is the best rating.

chains

none

Information about all the chains the place belongs to.

This object and child properties are part of the "Details" attribute group.

name

string¦null

none

The name of the chain.

icon

none

Details of an icon, suitable for depicting this place.

To fetch icon details use the icon query parameter.

url

string(url)

none

Url for an icon for this place or category in either svg, cim or png format.

Enumerated Values

price
cheap
moderate
expensive
veryExpensive

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close