Lookup queries return a full Place response. You may choose any of the fields below to return.
Field | Description | Example |
---|---|---|
placekey | String | zzy-224@5q9-bqm-sdv |
locationName | String | Tacos y Salsas |
address | Contains: streetAddress: String city: String region: String postalCode: String isoCountryCode: String | streetAddress: 1533 Stout St city: Denver region: CO postalCode: 80202 isoCountryCode: US |
latitude | Float | 39.745593 |
longitude | Float | -104.993886 |
topCategory | String. The label associated with the first 4 digits of the POI’s NAICS category. | Restaurants and Other Eating Places |
Insights | Contains: distanceFromCenter. Int. Denotes the distance in meters from the point used in aroundCoordinates argument. null if aroundCoordinates is not used. | 46 |
relatedPlaces | Contains: parent: Place response children: Array of Place responses | parent: { "placekey": "zzw-227@63s-ck8-xdv", "locationName": "King Of Prussia" } |
contactInfo | Contains: phoneNumber: String openHours: String | phoneNumber: +14151234567 openHours: { "Mon": [["8:00", "22:00"]], "Tue": [["8:00", "13:00"], ["18:00", "24:00"]], "Wed": [["0:00", "2:00"]], "Thu": [["0:00", "24:00"]], "Fri": [["23:00", "24:00"]], "Sat": [["0:00", "3:00"], ["15:00", "22:30"]], "Sun": [] } |
detailedInfo | Contains: subcategory: String naicsCode: Int openedOn: String closedOn: String brands: String Array categoryTags: String Array | subcategory: Full-Service Restaurants naicsCode: 722511 openedOn: 2019-05-12 closedOn: 2020-01-15 brands: Chipotle Mexican Grill" categoryTags: Counter Service, Mexican Food, Catering` |
geometry | Contains: polygonWKT: String polygonClass: String includesParkingLot: Boolean isSynthetic: Boolean isEnclosed: Boolean wktAreaSqMeters: Float | polygonWKT: Polygon ((-121.663310 36.715207, …, -121.663310 36.715207)) polygonClass: OWNED_POLYGON includesParkingLot: false isSynthetic: false isEnclosed: false wktAreaSqMeters: 184.363874629 |
Related Places
Some POIs are characterized by a broader footprint and encompass smaller POIs within their borders. We colloquially refer to the larger, containing POI as the parent
and the smaller POI as the child
.
For example, a mall may be the parent, and the stores within are the children.
We try to flag where these overlapping relationships exist in the real world by setting the parent_placekey of the smaller POI equal to the placekey of the larger, encompassing POI.
Contact Info
The API will return the phone number and open hours information for the place, if available.
Detailed Info
The API will return a variety of detailed fields about the place.
subcategory
returns the first 6 digits of the POI’s NAICS category, contrasted with topCategory
, which returns the first 4. For POIs with a 4-digit NAICS category, subcategory
column is null. For more detailed category information, use categoryTags.
openedOn
tracks the outside year and month this POI opened in yyyy-mm format. If null, then we do not have enough metadata to determine an open date. Similarly, closedOn
tracks the outside year and month this POI closed in yyyy-mm format. If null, then this POI is open. See the open and close logic for more details.
brands
contains the brand name if this POI is an instance of a larger brand that we have explicitly identified. See more details in brands.
Geometry
The API can return information about the place's shape. See our Geometry documentation for more information about these fields.