Types

AdditionalLocations

Example
Use dark colors for code blocksCopy
{
  "dropOff": {
    "x": -117.194769,
    "y": 34.057289
  },
  "frontDoor": {
    "x": -117.194769,
    "y": 34.057289
  },
  "road": {
    "x": -117.194769,
    "y": 34.057289
  },
  "roof": {
    "x": -117.194769,
    "y": 34.057289
  }
}

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.

Properties

Name	Type	Restrictions	Description
`dropOff`	`NullablePoint`	none	A location for drop-off/pick-up for a place.
`frontDoor`	`NullablePoint`	none	A location for the front door for a place.
`road`	`NullablePoint`	none	A road-side location for a place.
`roof`	`NullablePoint`	none	A location in the roof centroid for a place.

Address

Example
Use dark colors for code blocksCopy
{
  "streetAddress": "380 New York St",
  "extended": "Unit 32",
  "locality": "Redlands",
  "designatedMarketArea": "Los Angeles",
  "region": "CA",
  "postcode": "92373",
  "poBox": "string",
  "country": "US",
  "adminRegion": "Scotland",
  "postTown": "Edinburgh",
  "neighborhood": [
    "Downtown"
  ],
  "censusBlockId": "060710081003002"
}

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

Properties

Name	Type	Restrictions	Description
`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).

Name	Type	Required	Restrictions	Description
`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.

CategoryDetails

Example
Use dark colors for code blocksCopy
{
  "categoryId": "17119",
  "fullLabel": [
    [
      "Retail",
      "Sporting Goods Retail",
      "Bicycle Store"
    ]
  ],
  "parents": [
    [
      "17117"
    ]
  ],
  "icon": {
    "url": "https://static.arcgis.com/icons/places/Default_Shop_or_Service_15.svg"
  }
}

Provides details about a category or type of place.

Categories are hierarchical so that you can filter places based on specific categories such as "Provençal Restaurant", or with more generic types such as "Restaurant". A category such as "Provençal Restaurant" includes the details of its more generic parent, such as "French Restaurant".

Properties

Name	Type	Restrictions	Description
`categoryId`	`CategoryId`	none	A unique identifying string for a category. This matches the `categoryId` of a place's `category` property.
`fullLabel`	`[string]`	none	The full list of labels that describe the category, including its more generic parent categories.
`parents`	`[string]`	none	The list of parent category Ids for this category.
`icon`	`IconDetails`	none	Details of an icon, suitable for depicting this place. To fetch icon details use the `icon` query parameter.

CategoryId

Example
Use dark colors for code blocksCopy
"17119"

Type: string
Required: false
Restrictions: none

ChainInfo

Example
Use dark colors for code blocksCopy
{
  "name": "Starbucks"
}

Information about a chain that a place belongs to.

Properties

Name	Type	Required	Restrictions	Description
`name`	`string¦null`		none	The name of the chain.

ContactInfo

Example
Use dark colors for code blocksCopy
{
  "telephone": "(909) 793-2853",
  "website": "https://www.esri.com",
  "fax": "0800 169 2008",
  "email": "support@esri.com"
}

The contact information for a place.

Properties

Name	Type	Restrictions	Description
`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.

Error

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

Properties

Name	Type	Restrictions	Description
`error`	`object`	none	Error information
`code`	`integer`	none	A code identifying the type of error. This can be an HTTP status code, `498` (invalid or expired token), or `499` (missing token).
`message`	`string`	none	A message describing the error.
`details`	`[string]`	none	List of details about the error.
`restInfoUrl`	`string(url)`	none	A link to general information about the service, such as the owning system and token service URL. This property is only present for errors relating to tokens.

Enumerated Values

code

400

Click to copy

401

Click to copy

403

Click to copy

404

Click to copy

498

Click to copy

499

Click to copy

500

Click to copy

Hours

Example
Use dark colors for code blocksCopy
{
  "opening": {
    "monday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "tuesday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "wednesday": [
      {
        "from": "09:00",
        "to": "12:00"
      },
      {
        "from": "13:00",
        "to": "17:00"
      }
    ],
    "thursday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "friday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "saturday": [
      {
        "from": "10:00",
        "to": "17:00"
      }
    ],
    "sunday": [
      {
        "from": "11:00",
        "to": "12:00"
      }
    ]
  },
  "popular": {
    "monday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "tuesday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "wednesday": [
      {
        "from": "09:00",
        "to": "12:00"
      },
      {
        "from": "13:00",
        "to": "17:00"
      }
    ],
    "thursday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "friday": [
      {
        "from": "09:00",
        "to": "17:00"
      }
    ],
    "saturday": [
      {
        "from": "10:00",
        "to": "17:00"
      }
    ],
    "sunday": [
      {
        "from": "11:00",
        "to": "12:00"
      }
    ]
  },
  "openingText": "Mon-Thu 12:00 PM-11:00 PM; Fri-Sat 12:00 PM-11:30 PM; Sun 12:00 PM-10:30 PM"
}

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.

Properties

Name Type Required Restrictions Description

Name	Type	Restrictions	Description
`opening`	`HoursByDay`	none	The opening 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 from/to times: 09:00 paired with 12:00 and 13:00 with 17:00. Opening hours are shown in 24-hour time in the local timezone of the place or POI.
`popular`	`HoursByDay`	none	The popular or busy hours for a place. Popular 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 popular from 9:00 until 10:00 and then again from 14:00 until 15:00, it would contain two pairs of from/to times: 09:00 paired with 10:00 and 14:00 with 15:00. Popular 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.

opening

HoursByDay

none

The opening 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 from/to times: 09:00 paired with 12:00 and 13:00 with 17:00. Opening hours are shown in 24-hour time in the local timezone of the place or POI.

popular

HoursByDay

none

The popular or busy hours for a place.

Popular 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 popular from 9:00 until 10:00 and then again from 14:00 until 15:00, it would contain two pairs of from/to times: 09:00 paired with 10:00 and 14:00 with 15:00. Popular 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.

HoursByDay

Example
Use dark colors for code blocksCopy
{
  "monday": [
    {
      "from": "09:00",
      "to": "17:00"
    }
  ],
  "tuesday": [
    {
      "from": "09:00",
      "to": "17:00"
    }
  ],
  "wednesday": [
    {
      "from": "09:00",
      "to": "12:00"
    },
    {
      "from": "13:00",
      "to": "17:00"
    }
  ],
  "thursday": [
    {
      "from": "09:00",
      "to": "17:00"
    }
  ],
  "friday": [
    {
      "from": "09:00",
      "to": "17:00"
    }
  ],
  "saturday": [
    {
      "from": "10:00",
      "to": "17:00"
    }
  ],
  "sunday": [
    {
      "from": "11:00",
      "to": "12:00"
    }
  ]
}

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.

Properties

Name	Type	Restrictions
`monday`	`[TimeRange]`	none
`tuesday`	`[TimeRange]`	none
`wednesday`	`[TimeRange]`	none
`thursday`	`[TimeRange]`	none
`friday`	`[TimeRange]`	none
`saturday`	`[TimeRange]`	none
`sunday`	`[TimeRange]`	none

IconDetails

Example
Use dark colors for code blocksCopy
{
  "url": "https://static.arcgis.com/icons/places/Default_Shop_or_Service_15.svg"
}

Information about an icon for depicting a place or category.

Properties

Name	Type	Required	Restrictions	Description
`url`	`string(url)`		none	Url for an icon for this place or category in either `svg`, `cim` or `png` format.

NearPointResult

Example
Use dark colors for code blocksCopy
{
  "placeId": "2da082218b6f7538e52250999c8f8ef1",
  "location": {
    "x": -117.194769,
    "y": 34.057289
  },
  "categories": [
    {
      "categoryId": "11167",
      "label": "Technology Business"
    }
  ],
  "name": "Esri International",
  "distance": 50,
  "icon": {
    "url": "https://static.arcgis.com/icons/places/Default_Shop_or_Service_15.svg"
  }
}

A result of searching for places using a places/near-point request.

The result object includes a single place that satisfied the search and the distance from the search point, in meters.

Properties

Name	Type	Restrictions	Description
`placeId`	`PlaceId`	none	The unique Id of this place. This place Id can be passed to the `places/{placeId}` endpoint to retrieve additional details.
`location`	`Point`	none	The location of this place as a WGS84 point.
`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).
`name`	`string`	none	The name of the place, or point of interest. You can search for places by name using the `searchText` property in a `places/near-point` or `places/within-extent` request.
`distance`	`number`	none	The distance, in meters, from the place to the search point of a 'places/near-point` query.
`icon`	`IconDetails`	none	Details of an icon, suitable for depicting this place. To fetch icon details use the `icon` query parameter.

NullablePoint

Example
Use dark colors for code blocksCopy
{
  "x": -117.194769,
  "y": 34.057289
}

A point defined in WGS84 decimal degrees.

Properties

Name	Type	Required	Restrictions	Description
`x`	`XCoord`		none	The x, or longitude, of this location in WGS84 decimal degrees.
`y`	`YCoord`		none	The y, or latitude, of this location in WGS84 decimal degrees.

Pagination

Example
Use dark colors for code blocksCopy
{
  "previousUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=-117.194769&y=34.057289&radius=50.0&offset=0&pageSize=10",
  "nextUrl": "https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/places/near-point?x=-117.194769&y=34.057289&radius=50.0&offset=20&pageSize=10"
}

Provides pagination links for accessing more results for the current request.

Properties

Name Type Required Restrictions Description

Name	Type	Required	Restrictions	Description
`previousUrl`	`string(url)`		none	A url for fetching the previous page of results. Use this property to request the previous page of results if available. If this property is omitted then there are no previous pages of results. You must also supply authentication details, such as a `token`, to make a previous page request.
`nextUrl`	`string(url)`		none	A url for fetching the next page of results. Use this property to request the next page of results if available. If this property is omitted then there are no more pages of results available. You must also supply authentication details, such as a `token`, to make a next page request.

previousUrl

string(url)

none

A url for fetching the previous page of results.

Use this property to request the previous page of results if available. If this property is omitted then there are no previous pages of results. You must also supply authentication details, such as a token, to make a previous page request.

nextUrl

string(url)

none

A url for fetching the next page of results.

Use this property to request the next page of results if available. If this property is omitted then there are no more pages of results available. You must also supply authentication details, such as a token, to make a next page request.

PlaceDetails

Example
Use dark colors for code blocksCopy
{
  "placeId": "2da082218b6f7538e52250999c8f8ef1",
  "categories": [
    {
      "categoryId": "11167",
      "label": "Technology Business"
    }
  ],
  "name": "Esri International",
  "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": "string",
    "country": "US",
    "adminRegion": "Scotland",
    "postTown": "Edinburgh",
    "neighborhood": [
      "Downtown"
    ],
    "censusBlockId": "060710081003002"
  },
  "additionalLocations": {
    "dropOff": {
      "x": -117.194769,
      "y": 34.057289
    },
    "frontDoor": {
      "x": -117.194769,
      "y": 34.057289
    },
    "road": {
      "x": -117.194769,
      "y": 34.057289
    },
    "roof": {
      "x": -117.194769,
      "y": 34.057289
    }
  },
  "contactInfo": {
    "telephone": "(909) 793-2853",
    "website": "https://www.esri.com",
    "fax": "0800 169 2008",
    "email": "support@esri.com"
  },
  "socialMedia": {
    "facebookId": 183768242996,
    "twitter": "esri",
    "instagram": "esrigram"
  },
  "hours": {
    "opening": {
      "monday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "tuesday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "wednesday": [
        {
          "from": "09:00",
          "to": "12:00"
        },
        {
          "from": "13:00",
          "to": "17:00"
        }
      ],
      "thursday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "friday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "saturday": [
        {
          "from": "10:00",
          "to": "17:00"
        }
      ],
      "sunday": [
        {
          "from": "11:00",
          "to": "12:00"
        }
      ]
    },
    "popular": {
      "monday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "tuesday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "wednesday": [
        {
          "from": "09:00",
          "to": "12:00"
        },
        {
          "from": "13:00",
          "to": "17:00"
        }
      ],
      "thursday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "friday": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ],
      "saturday": [
        {
          "from": "10:00",
          "to": "17:00"
        }
      ],
      "sunday": [
        {
          "from": "11:00",
          "to": "12:00"
        }
      ]
    },
    "openingText": "Mon-Thu 12:00 PM-11:00 PM; Fri-Sat 12:00 PM-11:30 PM; Sun 12:00 PM-10:30 PM"
  },
  "rating": {
    "price": "cheap",
    "user": 4.5
  },
  "chains": [
    {
      "name": "Starbucks"
    }
  ],
  "icon": {
    "url": "https://static.arcgis.com/icons/places/Default_Shop_or_Service_15.svg"
  }
}

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.

Properties

Name	Type	Restrictions	Description
`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.
`name`	`string`	none	The name of the place, or point of interest. This property is part of the "Place" attribute group.
`location`	`Point`	none	The location of this place as a WGS84 point. This property is part of the "Location" attribute group.
`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 the place or point of interest (POI). This object and child properties are part of the "Address" attribute group.
`additionalLocations`	`AdditionalLocations`	none	A set of additional locations that represent the place as WGS84 points, for example the location of the front door, or of a drop off point. This object and child properties are part of the "Location" attribute group.
`contactInfo`	`ContactInfo`	none	Contact information for the place, such as the telephone number or email address. This object and child properties are part of the "Details" attribute group.
`socialMedia`	`SocialMedia`	none	Social media information associated with the place. This object and child properties are part of the "Details" attribute group.
`hours`	`Hours`	none	The operating hours for the place, including hours of opening and popular times. This object and child properties are part of the "Details" attribute group.
`rating`	`Rating`	none	Rating information supplied by users of the place. This object and child properties are part of the "Details" attribute group.
`chains`	`[ChainInfo]`	none	Information about all the chains the place belongs to. This object and child properties are part of the "Details" attribute group.
`icon`	`IconDetails`	none	Details of an icon, suitable for depicting this place. To fetch icon details use the `icon` query parameter.

PlaceId

Example
Use dark colors for code blocksCopy
"2da082218b6f7538e52250999c8f8ef1"

An ID that uniquely identifies a place.

A place ID is a 32 character string.

Type: string
Required: false
Restrictions: none
Minimum length: 32
Maximum length: 32

Point

Example
Use dark colors for code blocksCopy
{
  "x": -117.194769,
  "y": 34.057289
}

A point defined in WGS84 decimal degrees.

Properties

Name	Type	Required	Restrictions	Description
`x`	`XCoord`		none	The x, or longitude, of this location in WGS84 decimal degrees.
`y`	`YCoord`		none	The y, or latitude, of this location in WGS84 decimal degrees.

Rating

Example
Use dark colors for code blocksCopy
{
  "price": "cheap",
  "user": 4.5
}

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

Properties

Name	Type	Required	Restrictions	Description
`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.

Enumerated Values

price

cheap

Click to copy

moderate

Click to copy

expensive

Click to copy

veryExpensive

Click to copy

SearchDistance

Example
Use dark colors for code blocksCopy
50

A search distance in meters.

Type: number(float)
Required: false
Restrictions: none
Default value: 1000
Minimum: 1
Maximum: 10000

SocialMedia

Example
Use dark colors for code blocksCopy
{
  "facebookId": 183768242996,
  "twitter": "esri",
  "instagram": "esrigram"
}

The social media details for a place.

Properties

Name	Type	Restrictions	Description
`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.

TimeRange

Example
Use dark colors for code blocksCopy
{
  "from": "10:00",
  "to": "13:00"
}

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.

Properties

Name	Type	Required	Restrictions	Description
`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".

WithinExtentResult

Example
Use dark colors for code blocksCopy
{
  "placeId": "2da082218b6f7538e52250999c8f8ef1",
  "location": {
    "x": -117.194769,
    "y": 34.057289
  },
  "categories": [
    {
      "categoryId": "11167",
      "label": "Technology Business"
    }
  ],
  "name": "Esri International",
  "icon": {
    "url": "https://static.arcgis.com/icons/places/Default_Shop_or_Service_15.svg"
  }
}

A result of searching for places using a places/within-extent request.

The result object includes a single place that satisfied the search.

Properties

Name	Type	Restrictions	Description
`placeId`	`PlaceId`	none	The unique Id of this place. This place Id can be passed to the `places/{placeId}` endpoint to retrieve additional details.
`location`	`Point`	none	The location of this place as a WGS84 point.
`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).
`name`	`string`	none	The name of the place, or point of interest. You can search for places by name using the `searchText` property in a `places/near-point` or `places/within-extent` request.
`icon`	`IconDetails`	none	Details of an icon, suitable for depicting this place. To fetch icon details use the `icon` query parameter.

XCoord

Example
Use dark colors for code blocksCopy
-117.194769

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

Type: number(double)
Required: false
Restrictions: none
Minimum: -180
Maximum: 180

YCoord

Example
Use dark colors for code blocksCopy
34.057289

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

Type: number(double)
Required: false
Restrictions: none
Minimum: -90
Maximum: 90