Get place details

Get place attributes for hotels in Berlin by requesting different field groups

What are place details?

Place details are the attributes associated with a place such as name, street address, hours of operation, phone number, website, social media sites, and user ratings. The number of attributes available for a place can vary. For example, attributes such as opening hours may not be available for places that are geographic places or landmarks.

You can use place details to:

Return key attributes for a place.
Find the address and locale information.
Get telephone, email, and website information.
Get user and cost ratings.
Gain insight and compare places.

How to get place details

To get place attributes you use the places service /places/{placeId} request with a valid place ID. To get a place ID, you can perform a nearby search or bounding box search. Once you have a placeId, you need to define a list of the fields you would like with the requestedFields parameter. For example, requestedFields: ["name", "categoryId", "address:streetAddress"] or requestedFields: all.

The general steps are:

Get the places service URL.
Set the requestedFields parameter with the fields you are interested in.
Execute the request.

The fields you can use are listed below. They are organized into the following price groups:

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

URL request

Use dark colors for code blocksCopy
https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/<PLACE_ID>?token=<ACCESS_TOKEN>&f=pjson

Parameters

Name	In	Type	Default value	Description
`placeId`	path	`PlaceId`		The Id of the place for which you want to fetch additional details.
`requestedFields`	query	`array[string]`		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`	query	`string`	`none`	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).
`f`	query	`string`	`json`	The requested response format - either `json` or `pjson` (pretty json).
`token`	query	`string`		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>`

Code examples

Get place attributes

This example uses /places/{placeId} to get the place attributes for bd5f5dfa788b7c5f59f3bfe2cc3d9c60. The place attributes are the primary attributes for every place and include name and categories. The values are always valid. The attributes are displayed below.

Steps

Reference the places service.
Set the place ID.
In the requestedFields parameter, specify the fields from the Place group.
Set the token parameter to your access token.

Get the place group attributes for The White House.

APIs

ArcGIS REST JS

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

Esri Leaflet

MapLibre GL JS

OpenLayers

Expand

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
arcgisRest
  .getPlaceDetails({
    placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
    requestedFields: ["name", "categories"],
    authentication,
  })
  .then(results => {
    console.log(JSON.stringify(results, null, 2))
  })

Expand

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/bd5f5dfa788b7c5f59f3bfe2cc3d9c60' \
-d 'requestedFields=name,categories' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>' \

Run in Postman

Use dark colors for code blocksCopy

{
    "placeDetails": {
        "placeId": "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
        "categories": [
            {
                "categoryId": "12069",
                "label": "Government Department / Agency"
            }
        ],
        "name": "The White House"
    }
}

Get location attributes

This example uses /places/{placeId} to get the location attributes for cff0074688d7fc1c0a1cd65d83f29f38. The location attributes include location, drop off, front door, roof, and road coordinates. All of the valid attributes with valid values are displayed below. Attributes such as additionaLocations:frontDoor and additionalLocations:roof do not apply and are null.

Steps

Reference the places service.
Set the place ID.
In the requestedFields parameter, specify the fields from the location price group.
Set the token parameter to your access token.

Get the location group attributes for the Manheim Arena in Illinois.

APIs

ArcGIS REST JS

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

Esri Leaflet

MapLibre GL JS

OpenLayers

Expand

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
arcgisRest
  .getPlaceDetails({
    placeId: "cff0074688d7fc1c0a1cd65d83f29f38",
    requestedFields: [
      "location",
      "additionalLocations:dropOff",
      "additionalLocations:frontDoor",
      "additionalLocations:roof",
      "additionalLocations:road",
    ],
    authentication,
  })
  .then(results => {
    console.log(JSON.stringify(results, null, 2))
  })

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/cff0074688d7fc1c0a1cd65d83f29f38' \
-d 'requestedFields=location, additionalLocations:dropOff,additionalLocations:frontDoor,additionalLocations:roof,additionalLocations:road' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>' \

Run in Postman

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
    "placeDetails": {
        "placeId": "cff0074688d7fc1c0a1cd65d83f29f38",
        "location": {
            "x": 13.388524,
            "y": 52.510361
        },
        "additionalLocations": {
            "dropOff": {
                "x": 13.388529,
                "y": 52.510269
            },
            "frontDoor": null,
            "road": null,
            "roof": null
        }
    }
}

Get address attributes

This example uses /places/{placeId} to get the address attributes for bd5f5dfa788b7c5f59f3bfe2cc3d9c60. The address attributes describe the location and delivery information associated with a place. All of the attributes with valid values are displayed below. Attributes such as address:poBox, address:postTown, and address:extended do not apply and are null.ss

Steps

Reference the places service.
Set the place ID.
In the requestedFields parameter, specify the fields from the Address place group.
Set the token parameter to your access token.

Get the address group attributes for The White House.

APIs

ArcGIS REST JS

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

Esri Leaflet

MapLibre GL JS

OpenLayers

Expand

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
arcgisRest
  .getPlaceDetails({
    placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
    requestedFields: [
      "address:adminRegion",
      "address:censusBlockId",
      "address:country",
      "address:designatedMarketArea",
      "address:extended",
      "address:locality",
      "address:neighborhood",
      "address:poBox",
      "address:postcode",
      "address:postTown",
      "address:region",
      "address:streetAddress",
    ],
    authentication,
  })
  .then(results => {
    console.log(JSON.stringify(results, null, 2))
  })

Expand

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/bd5f5dfa788b7c5f59f3bfe2cc3d9c60' \
-d 'requestedFields=address:adminRegion,address:censusBlockId, address:country, address:designatedMarketArea,address:extended, address:locality, address:neighborhood, address:poBox, address:postcode, address:postTown, address:region, address:streetAddress' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>' \

Run in Postman

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
    "placeDetails": {
        "placeId": "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
        "address": {
            "streetAddress": "1600 Pennsylvania Ave NW",
            "extended": null,
            "locality": "Washington",
            "designatedMarketArea": "Washington, Dc-Hagrstwn",
            "region": "DC",
            "postcode": "20500",
            "poBox": null,
            "country": "US",
            "adminRegion": null,
            "postTown": null,
            "neighborhood": [
                "Downtown",
                "Franklin Mcpherson Square",
                "Northwest Washington"
            ],
            "censusBlockId": "110019800001034"
        }
    }
}

See full response

Get details attributes

This example uses /places/{placeId} to get the details attributes for bd5f5dfa788b7c5f59f3bfe2cc3d9c60. The details attributes include a description, contact, social, and rating information. All of the valid attributes with valid values are displayed below. Attributes such as hours:opening, rating:price, and chains do not apply and are null.

Steps

Reference the places service.
Set the place ID.
In the requestedFields parameter, specify the fields from the details price group.
Set the token parameter to your access token.

Get the details group attributes for The White House.

APIs

ArcGIS REST JS

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

Esri Leaflet

MapLibre GL JS

OpenLayers

Expand

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
arcgisRest
  .getPlaceDetails({
    placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
    requestedFields: [
      "contactInfo:telephone",
      "contactInfo:website",
      "contactInfo:fax",
      "contactInfo:email",
      "socialMedia:facebookId",
      "socialMedia:instagram",
      "socialMedia:twitter",
      "chains",
      "description",
      "rating:user",
      "rating:price",
      "hours:opening",
      "hours:popular",
      "hours:openingText",
    ],
    authentication,
  })
  .then(results => {
    console.log(JSON.stringify(results, null, 2))
  })

Expand

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl 'https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/bd5f5dfa788b7c5f59f3bfe2cc3d9c60' \
-d 'requestedFields=contactInfo:telephone,contactInfo:website,contactInfo:fax,contactInfo:email,socialMedia:facebookId,socialMedia:instagram,socialMedia:twitter,chains,description,rating:user,rating:price' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>' \

Run in Postman

Use dark colors for code blocks

Copy

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
    "placeDetails": {
        "placeId": "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
        "description": "The White House is the official residence & principal workplace of the President of the United States. The house was designed by Irish-born James Hoban, and built between 1792 & 1800 of white-painted Aquia Creek sandstone in the Neoclassical style. Residence of every U.S. president since John Adams.",
        "contactInfo": {
            "telephone": "(202) 456-1111",
            "website": "http://www.whitehouse.gov",
            "fax": "(202) 456-2461",
            "email": "comments@whitehouse.gov"
        },
        "socialMedia": {
            "facebookId": "1191441824276882",
            "twitter": "whitehouse",
            "instagram": "whitehouse"
        },
        "rating": {
            "price": null,
            "user": 4.4
        },
        "chains": []
    }
}

Tutorials

Find nearby places and details

Find points of interest near a location and get detailed information about them.

JavaScript Maps SDK Esri Leaflet MapLibre GL JS OpenLayers CesiumJS REST JS REST API

Find places in a bounding box

Perform a text-based search to find places within a bounding box.

Esri Leaflet MapLibre GL JS OpenLayers CesiumJS REST JS REST API