Local Falcon API Documentation

Informational Articles

• Obtaining an API Key
• Protecting Your API Credentials
• Standard Return Structure
• Error Codes

Data Retrieval Endpoints

Data Retrieval endpoint calls are read-only and return data associated with your Local Falcon account.

• List All Auto Scans
  Allows you to retrieve a list of all Auto Scans associated with your Local Falcon account.
  /v1/autoscans/
• List All Connected Locations
  Get a full list of all locations connected to your Local Falcon account.
  /v1/locations/
• List All Scan Reports
  Allows you to retrieve a list of all Scan Reports performed by your Local Falcon account.
  /v1/reports/
• Get Specific Scan Report
  Allows you to retrieve the full results of a Scan Report from the Local Falcon portal.
  /v1/reports/:report_key/
• List All Trend Reports
  Allows you to retrieve a list of all Trend Reports within your Local Falcon account.
  /v1/trend-reports/
• Get Specific Trend Report
  Allows you to retrieve the full results of a Trend Report from the Local Falcon portal.
  /v1/trend-reports/:report_key/
• List All Keyword Reports
  Allows you to retrieve a list of all Keyword Reports within your Local Falcon account.
  /v1/keyword-reports/
• Get Specific Keyword Report
  Allows you to retrieve the full results of a Keyword Report from the Local Falcon portal.
  /v1/keyword-reports/:report_key/
• List All Location Reports
  Allows you to retrieve a list of all Location Reports within your Local Falcon account.
  /v1/location-reports/
• Get Specific Location Report
  Allows you to retrieve the full results of a Location Report from the Local Falcon portal.
  /v1/location-reports/:report_key/

On-Demand Endpoints

On-Demand endpoint calls return the requested data, but are not saved to your Local Falcon account.

• Calculate Grid Points from Base Coordinate
  Returns all calculated coordinate points based on provided geocoordinate center point and distance arguments.
  /v1/grid/
• Search for Google My Business Locations
  Returns a list of found Google My Business locations based on search query, including Service Area Businesses (SAB)
  /v1/places/
• Get Business Ranking at Specific Coordinate Point
  Allows you to gather search results at the specified coordinate point and get ranking data for specified business.
  /v1/result/
• Keyword Search at a Specific Coordinate Point
  Allows you to gather search results at the specified coordinate point without any rank comparison data.
  /v1/search/
• Run a Full Grid Search
  Allows you to run a full grid search using the passed keyword or search term to match against the specified business.
  /v1/scan/