Platform LoginContact Support
Placer API

Trade Area by Drive Time Report

post
https://papi.placer.ai/v1/reports/trade-area/drive-time

This service lets you retrieve the trade area polygon calculated for a specified drive time.


📍 This service supports the Nearby Activity report. Once setting a value to the nearbyRadius parameter, the report will be generated based on the nearby activity logic.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

This service enables to pull the trade area polygon calculated based on a specified drive time.

date
required

Queried data start date. Format YYYY-MM-DD

date
required

Queried data end date. Format YYYY-MM-DD

string
required

Placer API Entity Id

string
enum
Defaults to weightedCentroid

The method for including the block group in the TA
Weighted centroid - the centroid is adjusted per the block’s group population. if it falls within the polygon the BG is included
Centroid - A block group’s data is included when the center of the block group falls within the trade area boundaries

Allowed:
integer
5 to 200
Defaults to 10

The max drive time duration threshold for trade area calculation in minutes; i.e. will exclude any visitor beyond this value.

filter
object

Filtering options for the report results.

integer
enum

The radius requested for nearby activity report generation.
Note: When a value is populated for this attribute - the report will be calculated as per the Nearby Activity report logic.

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago