v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Manage POIs

Search for Placer Entities

This service returns a list of Placer managed entities in a particular area. You can search based on any combination of the following filter parameters:<br/> entities within a specific location radius, entities associated with a specific group category/category/sub category, entity name or type.<br/> The response lists the matched entities, including address and location, zip code, group category, category ,sub-category and a link to Placer dashboard.<br/> The service supports pagination using the skip parameter. The first 1000 entities matching the criteria of the request are available.<br/> For available categories, see <a href="https://view-su2.highspot.com/viewer/87b4c810b4bc52f78f8fd2862fdf31dd">listed categories</a>.</br></br> <b>Note</b> that when using the radius parameter, the actual area being considered for searching POIs is the area within a square that is bounding the circle, which is defined by the requested radius.</br> <b>Please note:</b> In case you receive results where the isPermitted attribute is set to “false”, that means that you are not permitted to run reports for those. In case you wish to extend your permissions please contact <a href="mailto:support@placer.ai">customer support</a>.

get/v1/poi

Query parameters

latnumber float

Latitude of query location

Example:37.52

Latitude of query location, if specified then response will not include <glossary:Chains>

lngnumber float

Longitude of query location

Example:-121.98

Longitude of query location, if specified then response will not include chains

querystring

String included in the entity name

radiusnumber

Filter results by radius in miles. default value 0.01 miles

categorystring

Filter specific category

subCategorystring

Filter specific sub category

groupCategorystring

Filter specific group category i.e. Search POIs by business domains (e.g. Apparel,Dining, ....)

entityTypestring[]

Filter out specific entity type in search result. If this is not provided, all entity types will be returned

limitinteger

Search result limit

skipnumber
includeFlaggedEntitiesboolean

If the parameter is set to true, the response will also include flagged entities

Response

200 response

requestIdstring required

Request ID that can be used for tracing

Example response

{
  "requestId": "cfe57f50-fb64-11eb-8760-acde48001122:cfe56fce-fb64-11eb-8760-acde48001122"
}
All 33 operations