Scans & Reports

Run a Scan

Run a scan at the specified coordinate point and get ranking data for the specified business using your Local Falcon Credits.

Businesses used in the scans must already exist inside your Saved Locations in the Local Falcon Dashboard. Use the Save a Business Location to Account endpoint to add new locations before running a scan.

post/v2/run-scan/

Request

Base URL
https://api.localfalcon.com
Auth
none declared

Request body application/x-www-form-urlencoded

api_keystring required

Your Local Falcon API key.

place_idstring required

The platform 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' | '17' | '19' | '21' 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.

ai_analysis'true' | 'false'

Whether AI analysis should be generated for this scan. Defaults to false.

The platform to run the scan against.

eager'true' | 'false'

Whether to return a response eagerly within 20 seconds. When true, the API will respond within 20 seconds. When false, the API will wait as long as needed for the scan to complete. Defaults to false.

Response

Scan completed successfully.

codeinteger

code_descboolean

successboolean

messageboolean

Example response

{
  "code": 200,
  "success": true,
  "parameters": {
    "type": 1,
    "place_id": "ChIJzdUMEvHTxokRaBwKyttKwlw",
    "keyword": "home supply store near me",
    "lat": "39.7292366",
    "lng": "-75.0357437",
    "grid_size": "3",
    "distance": "0.5",
    "measurement": "mi",
    "platform": "google",
    "ai_analysis": true
  },
  "data": {
    "id": "33ec21769d25069d353b241fb2fe5f35",
    "checksum": "38be34e80decbc79be975bc2b0fd39b235c5b0726947acb280573159fb9da103",
    "report_key": "4df21b0fe569354",
    "timestamp": "1752850980",
    "date": "7/18/2025 11:03 AM",
    "looker_date": "20250718",
    "platform": "google",
    "place_id": "ChIJzdUMEvHTxokRaBwKyttKwlw",
    "keyword": "home supply store near me"
  }
}

Changes

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