Local Falcon

https://docs.localfalcon.com/
Admin
Local Falcon is an AI Visibility and local SEO platform that tracks and improves business visibility...
Tokens:53,010
Snippets:243
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### API Guides

Source: https://docs.localfalcon.com/llms.txt

Practical guides for using the Local Falcon API, covering a range of topics from basic usage to advanced workflows.

```APIDOC
## API Guides

Practical guides for the Local Falcon API — from your first scan to advanced multi-platform workflows.

- [Getting Started](https://docs.localfalcon.com/guides/getting-started): Your first scan in 5 minutes — step-by-step tutorial with cURL examples.
- [Metrics](https://docs.localfalcon.com/guides/metrics): What ARP, ATRP, SoLV, SAIV, and other ranking metrics mean and how to interpret them.
- [Grid Configuration](https://docs.localfalcon.com/guides/grid-configuration): Choose the right grid size (3×3 to 15×15) and radius for your scans.
- [Platforms](https://docs.localfalcon.com/guides/platforms): Compare all 7 scan platforms — Google Maps, Apple Maps, and AI assistants (ChatGPT, Gemini, Grok, Google AI Overviews, Google AI Mode).
- [Report Types](https://docs.localfalcon.com/guides/report-types): How scan, competitor, trend, location, keyword, and campaign reports relate to each other.
- [Fieldmasks](https://docs.localfalcon.com/guides/fieldmasks): Control which fields the API returns — syntax guide with per-endpoint copy-paste recipes.
- [Campaigns](https://docs.localfalcon.com/guides/campaigns): Schedule recurring scans across multiple locations and keywords vs one-off individual scans.
- [Errors & Async](https://docs.localfalcon.com/guides/errors-and-async): Handle async scan execution, polling patterns, rate limits, and error codes.
- [Examples](https://docs.localfalcon.com/guides/examples): Copy-paste API workflows for competitive analysis, multi-location monitoring, and AI visibility audits.
- [All Guides (full text)](https://docs.localfalcon.com/llms-full.txt): All guide content in a single file for AI agents — fetch this for complete guide coverage in one request.
```

--------------------------------

### Authentication via API Key (GET requests)

Source: https://docs.localfalcon.com/

Demonstrates how to authenticate GET requests using an API key as a query parameter.

```APIDOC
## GET Request Authentication Example

### Description
Authenticates a GET request by including the API key as a query parameter.

### Method
GET

### Endpoint
`/your/endpoint?api_key=YOUR_API_KEY`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API key for authentication.
```

--------------------------------

### List Locations Example

Source: https://docs.localfalcon.com/openapi.yaml

An example of how to list saved locations using the API.

```APIDOC
## POST /v1/locations/

### Description
Lists saved locations.

### Method
POST

### Endpoint
/v1/locations/

### Parameters
#### Request Body
- **api_key** (string) - Required - Your API key for authentication.

### Request Example
```
POST /v1/locations/ HTTP/1.1
Host: api.localfalcon.com
Content-Type: application/x-www-form-urlencoded

api_key=YOUR_API_KEY
```

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code.
- **code_desc** (string) - Status description.
- **success** (boolean) - Whether the request succeeded.
- **message** (string or false) - Error message if failed, `false` if successful.
- **parameters** (object) - Parameters received by the endpoint.
- **data** (object) - Response payload, containing a list of locations.
```

--------------------------------

### Schedule Autoscans (Node.js Fetch Example)

Source: https://docs.localfalcon.com/guides

This example demonstrates how to send a POST request to the /v1/autoscans/ endpoint using Node.js Fetch. It shows the structure for scheduling scans with parameters like api_key, limit, and frequency.

```javascript
fetch('https://api.localfalcon.com/v1/autoscans/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    api_key: '',
    limit: '10',
    start_date: '',
    end_date: '',
    place_id: '',
    keyword: '',
    grid_size: '3',
    frequency: 'one-time',
    status: 'scheduled',
    platform: '',
    next_token: ''
  })
})
```

--------------------------------

### Field Mask Parameter Example

Source: https://docs.localfalcon.com/openapi.yaml

This example demonstrates how to use the `fieldmask` parameter to specify which fields to return in the response, reducing payload size.

```http
fieldmask=report_key,arp,atrp,solv
```

--------------------------------

### Search Business Location Request Example

Source: https://docs.localfalcon.com/openapi.yaml

This example demonstrates how to search for a business location using the Local Falcon API. It requires an API key and the business name, with optional parameters for proximity and platform.

```json
{
  "code": 200,
  "code_desc": false,
  "success": true
}
```

--------------------------------

### List All Scan Reports POST Request Example

Source: https://docs.localfalcon.com/openapi.yaml

This example shows how to make a POST request to the /v1/reports/ endpoint to retrieve a list of scan reports. It includes the required 'api_key' and optional parameters like 'limit', 'start_date', and 'place_id'.

```http
POST /v1/reports/ HTTP/1.1
Host: api.localfalcon.com
Content-Type: application/x-www-form-urlencoded

api_key=YOUR_API_KEY&limit=20&start_date=01/01/2023&end_date=01/31/2023&place_id=ChIJ2VRoeR_YcEgRwPypNJIvj8A,ChIJz1_12345abcdeFGHIJklm
```

--------------------------------

### Processing Scan Example

Source: https://docs.localfalcon.com/openapi.yaml

This example shows a typical response when a scan is still processing. The status indicates that the operation is ongoing and a report key is provided for future reference.

```json
{
  "code": 202,
  "success": true,
  "message": "Scan is still processing",
  "data": {
    "report_key": "19c96a00485ef96",
    "status": "processing"
  }
}
```

--------------------------------

### Example API Response for Location Data

Source: https://docs.localfalcon.com/openapi.yaml

This example demonstrates a successful API response for a location query, including details like ID, platform, name, address, and rating. It also shows the structure for pagination with 'next_token'.

```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "query": ""
  },
  "data": {
    "count": 10,
    "next_token": "VFhwUk1rNTZZM2c9",
    "locations": [
      {
        "id": "ChIJ2VRoeR_YcEgRwPypNJIvj8A",
        "platform": "google",
        "place_id": "ChIJ2VRoeR_YcEgRwPypNJIvj8A",
        "name": "JWS COTSWOLD BUILDERS Ltd.",
        "address": "Weston House, Weston Rd, Bretforton, Evesham WR11 7HW, United Kingdom",
        "lat": "52.0865272",
        "lng": "-1.8584223",
        "rating": "0.000",
        "reviews": "0",
        "store_code": false,
        "url": "http://jwscotswold.co.uk/",
        "phone": "",
        "categories": {
          "construction_company": "Construction company"
        },
        "groups": []
      }
    ]
  }
}
```

--------------------------------

### Successful Grid Points Calculation Response

Source: https://docs.localfalcon.com/

This is an example of a successful response (200 OK) from the /v1/grid/ endpoint, showing the calculated grid points.

```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "lat": "40.1419777",
    "lng": "-74.8225408",
    "grid_size": "7",
    "radius": "5",
    "measurement": "mi"
  },
  "data": [
    {
      "lat": 40.069692964032754,
      "lng": -74.91709872286705
    },
    {
      "lat": 40.093787876021835,
      "lng": -74.91709872286705
    }
  ]
}
```

--------------------------------

### List Scheduled Scans Request Body

Source: https://docs.localfalcon.com/

This example shows the form URL-encoded request body for listing scheduled scans. It includes parameters like `api_key`, `limit`, `start_date`, `end_date`, `place_id`, `keyword`, `grid_size`, `frequency`, `status`, `platform`, and `next_token`.

```plaintext
api_key Required | Value  
  
| limit| 10  
| start_date| Value  
  
| end_date| Value  
  
| place_id| Value  
  
| keyword| Value  
  
| grid_size| 3  
| frequency| one-time  
| status| scheduled  
| platform| Value  
  
| next_token| Value  
```

--------------------------------

### Get Single Knowledge Base Article

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves the full content of a specific Knowledge Base article. The HTML content is converted to markdown, preserving formatting.

```APIDOC
## GET /v2/knowledge-base/{id}

### Description
Returns the full content of a single Knowledge Base article with HTML converted to markdown. Content is returned as markdown, preserving formatting. Image URLs are fully qualified. The `id` field returns with "KB" prefix, but the URL path accepts just the number.

### Method
GET

### Endpoint
/v2/knowledge-base/{id}

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Local Falcon API key.

#### Path Parameters
- **id** (integer) - Required - The numeric ID of the Knowledge Base article (e.g., 70).

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code.
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the details of the Knowledge Base article.
  - **id** (string) - The ID of the article, prefixed with "KB".
  - **title** (string) - The title of the article.
  - **summary** (string) - A brief summary of the article.
  - **content** (string) - The full content of the article in markdown format.
  - **categories** (array) - A list of categories the article belongs to.
  - **tags** (array) - A list of tags associated with the article.
  - **views** (integer) - The number of times the article has been viewed.
  - **up_votes** (integer) - The number of up votes the article has received.
  - **down_votes** (integer) - The number of down votes the article has received.
  - **date_created** (string) - The timestamp when the article was created.
  - **date_updated** (string) - The timestamp when the article was last updated.
  - **date_updated_formatted** (string) - The formatted date and time when the article was last updated.
  - **date_created_formatted** (string) - The formatted date and time when the article was created.

#### Response Example
```json
{
  "code": 200,
  "success": true,
  "data": {
    "id": "KB70",
    "title": "How To Use Local Falcon's AI Reviews Analysis Tool",
    "summary": "",
    "content": "Traditional sentiment analysis... [full markdown content]",
    "categories": [
      "Reviews"
    ],
    "tags": [
      "reviews analysis"
    ],
    "views": 82417,
    "up_votes": 0,
    "down_votes": 0,
    "date_created": "1718823798",
    "date_updated": "1751567728",
    "date_updated_formatted": "2025-07-03 14:35:28",
    "date_created_formatted": "2024-06-19 15:03:18"
  }
}
```
```

--------------------------------

### API Key Authentication (Direct REST API Access)

Source: https://docs.localfalcon.com/guides

Details on how to authenticate direct REST API calls using an API key, including methods for POST and GET requests, and alternative Bearer token authentication.

```APIDOC
## Authentication with API Key

### Method 1: Form Data (POST requests)
Pass your `api_key` as a form data field in the request body (`application/x-www-form-urlencoded`).

### Method 2: Query Parameter (GET requests)
Send `api_key` as a query parameter.

### Method 3: Bearer Token (All requests)
Alternatively, pass the API key value as a Bearer token in the `Authorization` header:
```
Authorization: Bearer YOUR_API_KEY
```
```

--------------------------------

### Get Business Ranking at Specific Coordinate Point

Source: https://docs.localfalcon.com/openapi.yaml

Get search results and ranking data at the specified coordinate point for a specified business. This endpoint runs searches only against Google Maps and requires on_demand_api_access permission.

```APIDOC
## POST /v1/result/

### Description
Get search results and ranking data at the specified coordinate point for a specified business.

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

### Method
POST

### Endpoint
/v1/result/

### Parameters
#### Request Body
- **api_key** (string) - Required - Your Local Falcon API key.
- **lat** (string) - Required - The data point latitude value.
- **lng** (string) - Required - The data point longitude value.
- **keyword** (string) - Required - The desired search term or keyword.
- **zoom** (string) - Optional - Desired zoom level. Expects 0 to 18. Defaults to 13.

### Response
#### Success Response (200)
- **code** (integer) - Description
- **code_desc** (boolean) - Description
- **success** (boolean) - Description
- **message** (boolean) - Description
- **parameters** (object) - Description
  - **lat** (string) - Description
  - **lng** (string) - Description
  - **keyword** (string) - Description
  - **zoom** (string) - Description

### Response Example
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "lat": "40.1419777",
    "lng": "-74.8225408",
    "keyword": "home supply store",
    "zoom": ""
  }
}
```

--------------------------------

### Free Trial Registration

Source: https://docs.localfalcon.com/llms.txt

Information on how to register for a free trial of Local Falcon, including details on promotional credits.

```APIDOC
## Free Trial

- Anyone can try Local Falcon for free — every new account receives over 100 promotional credits, enough to run multiple scans and generate multiple AI Analysis Reports
- Register at https://www.localfalcon.com/register
- No credit card required to start
```

--------------------------------

### Get Specific Trend Report

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves the full result of a specific Trend Report using its report key.

```APIDOC
## POST /v1/trend-reports/{report_key}

### Description
Allows you to retrieve the full result of a Trend Report from the Local Falcon.

### Method
POST

### Endpoint
/v1/trend-reports/{report_key}

### Parameters
#### Path Parameters
- **report_key** (string) - Required - The key of the report you wish to retrieve. Required if not included in parameters.

#### Request Body
- **api_key** (string) - Required - Your Local Falcon API key.
- **report_key** (string) - Optional - The key of the report you wish to retrieve. Required if not included in URL.

### Response
#### Success Response (200)
- **code** (integer)
- **code_desc** (boolean)
- **success** (boolean)
- **message** (boolean)
- **parameters** (object)
- **data** (object)
  - **id** (string)
  - **report_key** (string)
  - **last_timestamp** (string)
  - **last_date** (string)
  - **looker_last_date** (string)
  - **location** (object)
  - **keyword** (string)
  - **lat** (string)
  - **lng** (string)

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "report_key": "15660c271e19dad"
}
```

### Response Example
```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "limit": "",
    "place_id": "",
    "keyword": "",
    "next_token": ""
  },
  "data": {
    "id": "3ec2071a1504810a9cee38e03874a0c7",
    "report_key": "15660c271e19dad",
    "last_timestamp": "1687870863",
    "last_date": "6/27/2023 9:01 AM",
    "looker_last_date": "20230627",
    "location": {
      "place_id": "ChIJ6ULSRklQwYkR_V5GGobrWTc",
      "name": "Walmart Supercenter",
      "address": "180 Levittown Center, Levittown, PA 19055",
      "lat": "40.1420759",
      "lng": "-74.8225698",
      "rating": "3.700",
      "reviews": "6391",
      "store_code": false
    },
    "keyword": "home supply store near me",
    "lat": "40.1419777",
    "lng": "-74.8225408"
  }
}
```
```

--------------------------------

### Get Specific Campaign Report

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves the full result of a specific Campaign Report using its report key.

```APIDOC
## POST /v1/campaigns/{report_key}

### Description
Allows you to retrieve the full result of a Campaign Report from the Local Falcon.

### Method
POST

### Endpoint
/v1/campaigns/{report_key}

### Parameters
#### Path Parameters
- **report_key** (string) - Required - The unique identifier for the campaign report.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **code_desc** (boolean) - Description of the status code.
- **success** (boolean) - Indicates if the request was successful.
- **message** (boolean) - A message associated with the response.
- **parameters** (object) - Parameters used for the request.
- **data** (object) - Contains the campaign report data.
  - **count** (integer) - The number of reports.
  - **next_token** (string or boolean) - Token for pagination, if available.
  - **reports** (array) - An array of campaign report objects.
    - **id** (string) - The unique ID of the report.
    - **report_key** (string) - The key identifying the report.
    - **name** (string) - The name of the campaign report.
    - **locations** (string) - Number of locations associated with the report.
    - **keywords** (string) - Number of keywords tracked in the report.
    - **scans** (string) - Number of scans performed.
    - **grid_size** (string) - The grid size used for the report.
    - **radius** (string) - The radius setting for the report.
    - **measurement** (string) - The unit of measurement used (e.g., 'mi').
    - **frequency** (string) - How often the report is run.
    - **last_run** (string) - Timestamp of the last report run.
    - **last_run_date** (string) - Date and time of the last report run.
    - **next_run** (string or boolean) - Timestamp of the next scheduled run, if applicable.
    - **next_run_date** (string or boolean) - Date and time of the next scheduled run, if applicable.
    - **arp** (string) - Average Rank Position.
    - **arp_move** (string) - Change in Average Rank Position.
    - **atrp** (string) - Average Top Rank Position.
    - **atrp_move** (string) - Change in Average Top Rank Position.
    - **solv** (string) - Solvability score.
    - **solv_move** (string) - Change in Solvability score.
    - **public_url** (string) - A public URL to view the report.
    - **status** (string) - The current status of the report (e.g., 'paused').

#### Response Example
```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "limit": "",
    "start_date": "",
    "end_date": "",
    "place_id": "",
    "next_token": ""
  },
  "data": {
    "count": 1,
    "next_token": false,
    "reports": [
      {
        "id": "106a19450c2485fd1ee8cbefa2d4f144",
        "report_key": "742e9e6e76f24a2",
        "name": "Local Falcon Campaigns Demo",
        "locations": "20",
        "keywords": "3",
        "scans": "60",
        "grid_size": "7",
        "radius": "5",
        "measurement": "mi",
        "frequency": "every two weeks",
        "last_run": "1687870863",
        "last_run_date": "6/27/2023 9:01 AM",
        "next_run": false,
        "next_run_date": false,
        "arp": "11.35",
        "arp_move": "0.59",
        "atrp": "20.58",
        "atrp_move": "0.02",
        "solv": "0.85",
        "solv_move": "0.07",
        "public_url": "https://localrankingtracker.com/campaign-report/742e9e6e76f24a2/018aeaee55712f6/",
        "status": "paused"
      }
    ]
  }
}
```
```

--------------------------------

### Run Campaign

Source: https://docs.localfalcon.com/openapi.yaml

Manually trigger a Campaign to run immediately. The total amount of credits that will be used by calling this endpoint and running the campaign will be checked against your available credits in the Local Falcon Dashboard.

```APIDOC
## POST /v2/campaigns/run

### Description
Manually trigger a Campaign to run immediately.

The total amount of credits that will be used by calling this endpoint and running the campaign will be checked against your available credits in the Local Falcon Dashboard.

### Method
POST

### Endpoint
/v2/campaigns/run

### Parameters
#### Request Body
- **api_key** (string) - Required - Your Local Falcon API key.
- **campaign_key** (string) - Required - The key of the campaign you wish to run.

### Request Example
{
  "api_key": "YOUR_API_KEY",
  "campaign_key": "YOUR_CAMPAIGN_KEY"
}

### Response
#### Success Response (200)
- **code** (integer) - Description
- **code_desc** (boolean) - Description
- **success** (boolean) - Description
- **message** (string) - Description
- **parameters** (object) - Description
- **data** (array) - Description

#### Response Example
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": "60 scans queued successfully.",
  "parameters": {
    "campaign_key": "742e9e6e76f24a2"
  },
  "data": []
}
```

--------------------------------

### Authentication via API Key (POST requests)

Source: https://docs.localfalcon.com/

Demonstrates how to authenticate POST requests using an API key as a form data field.

```APIDOC
## POST Request Authentication Example

### Description
Authenticates a POST request by sending the API key as a form data field in the request body.

### Method
POST

### Endpoint
`/your/endpoint`

### Parameters
#### Request Body
- **api_key** (string) - Required - Your API key for authentication.
```

--------------------------------

### Get Reports with Filters

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves reports with optional filters for campaign, platform, and specific fields. Supports pagination.

```APIDOC
## GET /reports

### Description
Retrieves a list of reports based on specified filters. This endpoint allows for filtering by campaign, platform, and specific fields, and supports pagination to retrieve large datasets.

### Method
GET

### Endpoint
/reports

### Parameters
#### Query Parameters
- **campaign** (string) - Optional - Filter only for scans from a specific Campaign.
- **platform** (string) - Optional - Filter only results for specific Platforms. Expects either one or multiple values of aimode, apple, chatgpt, gaio, gemini, google, grok; separated by commas.
- **fields** (string) - Optional - This parameter is used to target specific fields for the API to return. Expects single or comma delimited values of available data that the endpoint normally returns.
- **next_token** (string) - Optional - This parameter is used to get the next 'page' of results. The value used with the parameter is provided from a previous response by this endpoint if more 'pages' of results exist.

### Response
#### Success Response (200)
- **code** (integer) - HTTP status code.
- **code_desc** (boolean) - Description of the code.
- **success** (boolean) - Indicates if the request was successful.
- **message** (boolean) - Message associated with the response.
- **parameters** (object) - Parameters used in the request.
- **data** (object) - Contains the report data.
  - **count** (integer) - The number of reports returned.
  - **next_token** (string) - Token for retrieving the next page of results.
  - **reports** (array) - An array of report objects.
    - **id** (string) - Unique identifier for the report.
    - **checksum** (string) - Checksum of the report.
    - **report_key** (string) - Key identifying the report.
    - **timestamp** (string) - Timestamp of the report.
    - **date** (string) - Date of the report.
    - **looker_date** (string) - Date formatted for Looker.
    - **type** (string) - Type of the report.
    - **platform** (string) - Platform associated with the report.
    - **place_id** (string) - Place ID associated with the report.
    - **location** (object) - Location details.
    - **keyword** (string) - Keyword associated with the report.
    - **lat** (string) - Latitude.
    - **lng** (string) - Longitude.
    - **grid_size** (string) - Grid size.
    - **radius** (string) - Radius.
    - **measurement** (string) - Measurement value.
    - **data_points** (string) - Data points.
    - **found_in** (string) - Where the data was found.
    - **arp** (string) - ARP value.
    - **atrp** (string) - ATRP value.
    - **solv** (string) - SOLV value.
    - **image** (string) - Image URL.
    - **heatmap** (string) - Heatmap URL.
    - **pdf** (string) - PDF URL.
    - **public_url** (string) - Public URL for the report.

### Request Example
```json
{
  "example": "GET /reports?platform=google,apple&fields=id,date,platform"
}
```

### Response Example
```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "limit": "",
    "start_date": "",
    "end_date": "",
    "place_id": "",
    "keyword": "",
    "grid_size": "",
    "next_token": ""
  },
  "data": {
    "count": 10,
    "next_token": "VGtSTmVrOUVRVFZPZHowOQ==",
    "reports": [
      {
        "id": "33ec21769d25069d353b241fb2fe5f35",
        "checksum": "38be34e80decbc79be975bc2b0fd39b235c5b0726947acb280573159fb9da103",
        "report_key": "4df21b0fe569354",
        "timestamp": "1752850980",
        "date": "7/18/2025 11:03 AM",
        "looker_date": "20250718",
        "type": "manual",
        "platform": "google",
        "place_id": "ChIJzdUMEvHTxokRaBwKyttKwlw",
        "location": {},
        "keyword": "",
        "lat": "",
        "lng": "",
        "grid_size": "",
        "radius": "",
        "measurement": "",
        "data_points": "",
        "found_in": "",
        "arp": "",
        "atrp": "",
        "solv": "",
        "image": "",
        "heatmap": "",
        "pdf": "",
        "public_url": ""
      }
    ]
  }
}
```
```

--------------------------------

### Run a Scan

Source: https://docs.localfalcon.com/openapi.yaml

Initiates a scan at a specified coordinate point to gather ranking data for a business using Local Falcon Credits.

```APIDOC
## POST /v2/run-scan/

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

### Method
POST

### Endpoint
/v2/run-scan/

### Summary
Run a Scan
```

--------------------------------

### Get Specific Competitor Report

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves the full result of a Competitor Report using its unique report key.

```APIDOC
## POST /v1/competitor-reports/{report_key}

### Description
Allows you to retrieve the full result of a Competitor Report within your Local Falcon account.

### Method
POST

### Endpoint
/v1/competitor-reports/{report_key}

### Parameters
#### Path Parameters
- **report_key** (string) - Required - The key of the report you wish to retrieve.

#### Request Body
- **api_key** (string) - Required - Your Local Falcon API key.
- **report_key** (string) - Optional - The key of the report you wish to retrieve. Required if not included in URL.

### Response
#### Success Response (200)
- **code** (integer)
- **code_desc** (boolean)
- **success** (boolean)
- **message** (boolean)
- **parameters** (object)
- **data** (object)
  - **count** (integer)
  - **next_token** (string)
  - **reports** (array)
    - **id** (string)
    - **checksum** (string)
    - **report_key** (string)
    - **timestamp** (string)
    - **date** (string)
    - **looker_date** (string)
    - **type** (string)
    - **place_id** (string)
    - **location** (object)
      - **place_id** (string)
      - **name** (string)
      - **address** (string)
      - **lat** (string)
      - **lng** (string)
      - **rating** (string)
      - **reviews** (string)
      - **store_code** (boolean)
    - **keyword** (string)
    - **lat** (string)
    - **lng** (string)
    - **grid_size** (string)
    - **radius** (string)
    - **measurement** (string)
    - **data_points** (string)
    - **found_in** (string)
    - **arp** (string)
    - **atrp** (string)
    - **solv** (string)
    - **image** (string)
    - **pdf** (string)
    - **public_url** (string)

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "report_key": "example_report_key"
}
```

### Response Example
```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": {
    "limit": "",
    "start_date": "",
    "end_date": "",
    "place_id": "",
    "keyword": "",
    "grid_size": "",
    "next_token": ""
  },
  "data": {
    "count": 10,
    "next_token": "VGtSTmVrOUVRVFZPUVQwOQ==",
    "reports": [
      {
        "id": "8043fd66e75eb73d7f896d9e901995bf",
        "checksum": "66f869ccbf5235d7ae4e0d0eb28909c36e46e07653172a083647691772d69d0a",
        "report_key": "8033268405f23ac",
        "timestamp": "1687870863",
        "date": "6/27/2023 9:01 AM",
        "looker_date": "20230627",
        "type": "campaign",
        "place_id": "ChIJ6ULSRklQwYkR_V5GGobrWTc",
        "location": {
          "place_id": "ChIJ6ULSRklQwYkR_V5GGobrWTc",
          "name": "Walmart Supercenter",
          "address": "180 Levittown Center, Levittown, PA 19055",
          "lat": "40.1420759",
          "lng": "-74.8225698",
          "rating": "3.700",
          "reviews": "6391",
          "store_code": false
        },
        "keyword": "home supply store near me",
        "lat": "40.1419777",
        "lng": "-74.8225408",
        "grid_size": "7",
        "radius": "5",
        "measurement": "mi",
        "data_points": "49",
        "found_in": "0",
        "arp": "21.00",
        "atrp": "21.00",
        "solv": "0.00",
        "image": "https://lf-static-v2.localfalcon.com/image/8033268405f23ac/018aeaee55712f6",
        "pdf": "https://lf-pdf-ecs.localfalcon.com/scan-report/8033268405f23ac/018aeaee55712f6/",
        "public_url": "https://localrankingtracker.com/scan-report/8033268405f23ac/018aeaee55712f6/"
      }
    ]
  }
}
```

--------------------------------

### Get Specific Keyword Report

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves the full result of a specific Keyword Report using its unique report key.

```APIDOC
## POST /v1/keyword-reports/{report_key}

### Description
Allows you to retrieve the full result of a Keyword Report from the Local Falcon.

### Method
POST

### Endpoint
/v1/keyword-reports/{report_key}

### Parameters
#### Path Parameters
- **report_key** (string) - Required - The key of the report you wish to retrieve. Required if not included in parameters.

#### Request Body
- **api_key** (string) - Required - Your Local Falcon API key.
- **report_key** (string) - Optional - The key of the report you wish to retrieve. Required if not included in URL.

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "report_key": "675c340e3891a6e"
}
```

### Response
#### Success Response (200)
- **code** (integer)
- **code_desc** (boolean)
- **success** (boolean)
- **message** (boolean)
- **parameters** (object)
- **data** (object)
  - **id** (string)
  - **report_key** (string)
  - **last_timestamp** (integer)
  - **last_date** (string)
  - **looker_last_date** (string)
  - **keyword** (string)
  - **location_count** (integer)
  - **scan_count** (integer)
  - **avg_arp** (string)
  - **avg_atrp** (string)
  - **avg_solv** (string)
  - **pdf** (string)
  - **public_url** (string)
  - **scans** (array)

#### Response Example
```json
{
  "code": 200,
  "code_desc": false,
  "success": true,
  "message": false,
  "parameters": [],
  "data": {
    "id": "44d4293351c9f751f0ad4c8c8c025487",
    "report_key": "efb0c0ca0382449",
    "last_timestamp": 0,
    "last_date": "12/31/1969 7:00 PM",
    "looker_last_date": "19691231",
    "keyword": "home supply store near me",
    "location_count": 1,
    "scan_count": 0,
    "avg_arp": "0.00",
    "avg_atrp": "0.00",
    "avg_solv": "0.00",
    "pdf": "https://lf-pdf-ecs.localfalcon.com/keyword-report/efb0c0ca0382449/018aeaee55712f6/",
    "public_url": "https://localrankingtracker.com/keyword-report/efb0c0ca0382449/018aeaee55712f6/",
    "scans": []
  }
}
```
```

--------------------------------

### OAuth 2.1 Authentication (MCP Server)

Source: https://docs.localfalcon.com/guides

Information on using OAuth 2.1 via the Local Falcon MCP server for secure integration with AI agents, connector directories, and third-party applications.

```APIDOC
## OAuth 2.1 via MCP Server

Connect to the MCP server at `https://mcp.localfalcon.com`.
This method is recommended for AI platforms, connector directories, and any third-party integration.
The MCP server implements OAuth 2.1 Authorization Code flow with PKCE (mandatory S256) and exposes all API capabilities as structured tools with built-in session management.
```

--------------------------------

### Authentication via Bearer Token

Source: https://docs.localfalcon.com/

Demonstrates how to authenticate requests using an API key as a Bearer token in the Authorization header.

```APIDOC
## Bearer Token Authentication Example

### Description
Authenticates requests by passing the API key as a Bearer token in the `Authorization` header.

### Method
ANY (e.g., GET, POST)

### Endpoint
`/your/endpoint`

### Headers
- **Authorization**: `Bearer YOUR_API_KEY`
```

--------------------------------

### Knowledge Base Operations

Source: https://docs.localfalcon.com/

Endpoints for searching and retrieving articles from the Local Falcon Knowledge Base using GET requests.

```APIDOC
## Knowledge Base

### Description
Search and retrieve articles from the Local Falcon Knowledge Base. These endpoints use **GET** requests with the API key passed as a query parameter.

### Operations
* `GET /v2/knowledge-base/{id}`
* `GET /v2/knowledge-base/`
```

--------------------------------

### Get Report by Key

Source: https://docs.localfalcon.com/openapi.yaml

Retrieves a specific report using its unique key, with options to specify which fields to include in the response.

```APIDOC
## GET /reports/{report_key}

### Description
Retrieves a specific report identified by its unique key.

### Method
GET

### Endpoint
/reports/{report_key}

### Parameters
#### Path Parameters
- **report_key** (string) - Required - The unique key identifying the report.

#### Query Parameters
- **api_key** (string) - Required - Your Local Falcon API key, passed as a query parameter. Used for GET requests.
- **fieldmask** (string) - Optional - A comma-separated list of fields to include in the response. Use dot notation for nested fields and asterisk (*) as a wildcard within arrays. For example: "report_key,arp,atrp,solv" or "reports.*.report_key,reports.*.date".

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the outcome of the request.
- **parameters** (object) - The parameters used for the request.
- **data** (object) - The main data payload of the response, containing the requested report details.
```
Tokens:
Raw