---
title: "Run a Scan"
method: POST
path: "/v2/run-scan/"
tags: ["Scans & Reports"]
---

# Run a Scan

`POST /v2/run-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.

## Response `200`

Scan completed successfully.

- object
  - `code` integer
  - `code_desc` boolean
  - `success` boolean
  - `message` boolean
  - `parameters` object
    - `type` integer
    - `place_id` string
    - `keyword` string
    - `lat` string
    - `lng` string
    - `grid_size` string
    - `distance` string
    - `measurement` string
    - `platform` string
    - `ai_analysis` boolean
  - `data` object
    - `id` string
    - `checksum` string
    - `report_key` string
    - `campaign_report_key` boolean
    - `timestamp` string
    - `date` string
    - `looker_date` string
    - `platform` string
    - `place_id` string
    - `location` object
      - `platform` string
      - `place_id` string
      - `lat` string
      - `lng` string
      - `name` string
      - `address` string
      - `rating` string
      - `rating_pct` string
      - `reviews` string
      - `phone` string
      - `url` string
      - `display_url` string
      - `claimed` boolean
      - `categories` object
      - `store_code` boolean
    - `keyword` string
    - `lat` string
    - `lng` string
    - `grid_size` string
    - `radius` string
    - `measurement` string
    - `points` string
    - `found_in` string
    - `arp` string — Average Rank Position
    - `atrp` string — Average Top Rank Position
    - `solv` string — Share of Local Voice
    - `unique_competitors` integer
    - `image` string, uri
    - `heatmap` string, uri
    - `pdf` string, uri
    - `public_url` string, uri
    - `data_points` object[]
      - `lat` string
      - `lng` string
      - `found` boolean
      - `rank` boolean
      - `count` integer
      - `results` object[]

## Other responses

- `202` — Scan is still processing
- `400` — The request was malformed or missing required parameters.
- `401` — The API key is missing, invalid, or does not have permission for the requested resource.
- `429` — You have exceeded the rate limit. Please wait before making additional requests.
- `500` — An unexpected error occurred on the server. Please try again later.

---

[API](https://skmtc.net/localfalcon/apis/local-falcon-api.md) · [All operations](https://skmtc.net/localfalcon/apis/local-falcon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/localfalcon/local-falcon-api/revisions/5487f4bd451b/schema)