# Local Falcon API Documentation

> Local Falcon is an AI Visibility and local SEO platform. Track and improve business visibility across AI search platforms (ChatGPT, Gemini, Grok, Google AI Overviews, AI Mode) and in local search (Google Maps, Apple Maps). This file provides machine-readable API documentation for Local Falcon.

## OpenAPI Specification

- [openapi.yaml](https://docs.localfalcon.com/openapi.yaml): Full OpenAPI 3.x specification — fetch this for complete endpoint definitions, parameters, request/response schemas, and authentication details.

## 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.

## Related Resources

- [Main Site](https://www.localfalcon.com): Product information and knowledge base
- [MCP Server](https://mcp.localfalcon.com): Model Context Protocol server (OAuth 2.1)
- [Remote MCP Connector (GitHub)](https://github.com/local-falcon/mcp): Source code and setup instructions for the Local Falcon MCP connector
- [llms.txt (main site)](https://www.localfalcon.com/llms.txt): Full platform overview for AI agents
- [FAQ / Answers](https://www.localfalcon.com/answers): Frequently asked questions
- [Features](https://www.localfalcon.com/features): Complete feature set with detailed subpages
- [Sitemap](https://www.localfalcon.com/sitemap.xml): Full sitemap for all pages

## 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