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, phone number, website, and social media sites. The number of attributes available for a place can vary.

You can use place details to:

Return key attributes for a place.
Find the address and locale information.
Get telephone, email, and website information.
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`
Address	`address:adminRegion`, `address:country`, `address:extended`, `address:locality`, `address:poBox`, `address:postTown`, `address:postcode`, `address:region`, `address:streetAddress`
Details	`contactInfo:telephone`, `contactInfo:website`, `contactInfo:fax`, `contactInfo:email`, `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.
`icon`	query	`string`	`none`	Determines whether icons are returned and the type of icon to use with a place or category.
`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.

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.ss
Set the token parameter to your access token.

Get the place group attributes for The White House.

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Esri Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

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
places.fetchPlace({
  placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
  requestedFields: ["name", "categories"]
})
.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": "4bf58dd8d48988d126941735",
                "label": "Government Building"
            },
            {
                "categoryId": "4bf58dd8d48988d12d941735",
                "label": "Monument"
            }
        ],
        "name": "The White House"
    }
}

Get location attributes

This example uses /places/{placeId} to get the location attributes for cff0074688d7fc1c0a1cd65d83f29f38.

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 Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Esri Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

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
places.fetchPlace({
  placeId: "cff0074688d7fc1c0a1cd65d83f29f38",
  requestedFields: [
    "location"
  ]
})
.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' \
-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
{
    "placeDetails": {
        "placeId": "cff0074688d7fc1c0a1cd65d83f29f38",
        "location": {
            "x": 13.388524,
            "y": 52.510361
        }
    }
}

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.

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 Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Esri Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

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
places.fetchPlace({
  placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
  requestedFields: [
    "address:adminRegion",
    "address:country",
    "address:extended",
    "address:locality",
    "address:poBox",
    "address:postcode",
    "address:postTown",
    "address:region",
    "address:streetAddress"
  ]
})
.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:country,address:extended, address:locality, 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
{
  "placeDetails": {
    "placeId": "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
    "address": {
      "streetAddress": "1600 Pennsylvania Ave NW",
      "extended": null,
      "locality": "Washington",
      "region": "DC",
      "postcode": "20500",
      "poBox": null,
      "country": "US",
      "adminRegion": null,
      "postTown": null
    }
  }
}

See full response

Get details attributes

This example uses /places/{placeId} to get the details attributes for bd5f5dfa788b7c5f59f3bfe2cc3d9c60. The details attributes include contact and social media information. All of the valid attributes with valid values are displayed below.

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 Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Esri Leaflet

MapLibre GL JS

OpenLayers

CesiumJS

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
places.fetchPlace({
  placeId: "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
  requestedFields: [
    "contactInfo:telephone",
    "contactInfo:website",
    "contactInfo:fax",
    "contactInfo:email",
    "socialMedia:facebookId",
    "socialMedia:instagram",
    "socialMedia:twitter"
  ]
})
.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' \
-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
{
    "placeDetails": {
      "placeId": "bd5f5dfa788b7c5f59f3bfe2cc3d9c60",
      "contactInfo": {
        "telephone": "(202) 456-1414",
        "website": "https://www.whitehouse.gov",
        "fax": null,
        "email": "comments@whitehouse.gov"
      },
      "socialMedia": {
        "facebookId": "1191441824276882",
        "twitter": "whitehouse",
        "instagram": "whitehouse"
      }
    }
  }

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