The POI operation retrieves a list of POIs within a certain radius distance from center of point identified by lon, lat coordinates. It takes in the following parameters:
Parameter | Description | Data Type | Value/Example |
---|---|---|---|
centerLngLat |
Coordinate of the center point representing in lon, lat format. | List of comma -separated long/lat pairs, separated by semi-colons | |
region |
The data region in which pings are located. | Enum | NA(default) AF AS EU NA OC SA ME |
radius |
radius distance from center of point. | string | |
radiusUnits |
Units used for the radius distances in Miles or Kilometers. The default is miles. | Enum | English Metric |
poiCategories |
Categories of point of interest with comma delimited choices, such as "Dining, Lodging, Gas". Note it's also valid but not recommended to provide an Integer value listed in POIType table. The Integer value can be 1 or 2 or 4 and so on, which represents a single category of POI. The value can also be the sum of each category value desired. For example, An Integer value of 1088 equals the sum of 64 and 1024, which represents 64-Dining and 1024-Gas and is regarded same as "Dining, Gas". |
object | |
nameFilter |
It is used to filter the results with the supplied value. | string | |
dataset |
For users licensed for multiple regional datasets. | Enum | PCM_EU PCM_OC PCM_SA PCM_ME PCM_AS PCM_AF PCM_WW(Worldwide) PCM_GT(GeoTrack) Current(default) |
The radius search will return up to 3000 POI's regardless of the miles requested. In some cases you may need to specify a smaller radius to get a complete list of matches. Also, the API uses air miles not road miles.
See here for response body details.