On-Demand API

Run a Full Grid Search

Get search results and ranking data for the specified business across a full grid of coordinate points.

This endpoint runs searches only against Google Maps and requires on_demand_api_access permission.

post/v1/scan/

Request

api_keystring required

Your Local Falcon API key.

place_idstring required

The Google Place ID of the business to match against in results.

keywordstring required

The desired search term or keyword.

latstring required

The data point latitude value.

lngstring required

The data point longitude value.

grid_size'3' | '5' | '7' | '9' | '11' | '13' | '15' required

The size of your desired grid.

radiusstring required

The radius of your grid from center point to outer most north/east/south/west point. Expects 0.1 to 100.

measurement'mi' | 'km' required

The measurement unit of your radius.

Full grid search completed successfully.

No recorded changes to this operation across all 5 revisions of this API.