v1

latestOpenAPI 3.0.32026-07-13404294.7 KB

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/

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"
  }
}