/places/{placeId}

Click to copy

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: 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 V2 service to request additional attributes for places retrieved using the Places for basemaps workflow.

Query parameters

Name	Type	Default value	Description
`requestedFields`	`array[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 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

Click to copy

additionalLocations

Click to copy

additionalLocations:dropOff

Click to copy

additionalLocations:frontDoor

Click to copy

additionalLocations:road

Click to copy

additionalLocations:roof

Click to copy

address

Click to copy

address:adminRegion

Click to copy

address:censusBlockId

Click to copy

address:country

Click to copy

address:designatedMarketArea

Click to copy

address:extended

Click to copy

address:locality

Click to copy

address:neighborhood

Click to copy

address:poBox

Click to copy

address:postcode

Click to copy

address:postTown

Click to copy

address:region

Click to copy

address:streetAddress

Click to copy

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

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

Name	Type	Required	Default value	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.

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/{placeId}?requestedFields=all \
  -H 'Accept: application/json'

Response

A successful response for a places/{placeId} request.

Use dark colors for code blocksCopy
{
  "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

Use dark colors for code blocksCopy
{
  "error": {
    "code": 400,
    "message": "Parameter invalid.",
    "details": [
      "string"
    ],
    "restInfoUrl": "https://places-api.arcgis.com/arcgis/rest/info"
  }
}

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`	Unknown	An error occurred on the server.	Error

Response details

Status Code 200

Name	Type	Restrictions	Description
`placeDetails`	`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`	`PlaceId`	none	The unique Id of this place.
`categories`	`[Category]`	none	A list of category objects for a place. Categories are uniquely identified by a `categoryId`. For example, `17119` identifies a "Bicycle Store" and `10051` 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`	`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, 17119 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`	`Point`	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`	`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`	`AdditionalLocations`	none	A set of additional locations for the place. This list provides alternative locations for accessing a place such as `frontDoor` or `road`.
`dropOff`	`NullablePoint¦null`	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`	`NullablePoint¦null`	none	A point defined in WGS84 decimal degrees.
`road`	`NullablePoint¦null`	none	A point defined in WGS84 decimal degrees.
`roof`	`NullablePoint¦null`	none	A point defined in WGS84 decimal degrees.
`contactInfo`	`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`	`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`	`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`	`HoursByDay¦null`	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`	`[TimeRange]`	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`	`[TimeRange]`	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`	`[TimeRange]`	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`	`[TimeRange]`	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`	`[TimeRange]`	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`	`[TimeRange]`	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`	`[TimeRange]`	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`	`HoursByDay¦null`	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`	`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`	`[ChainInfo]`	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`	`IconDetails`	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

Click to copy

moderate

Click to copy

expensive

Click to copy

veryExpensive

Click to copy

ArcGIS REST APIsPlaces serviceAPI reference

/places/{placeId}

Was this page helpful?