POST
/
v1
/
insights
/
chat
curl --request POST \
  --url https://api.findloka.com/v1/insights/chat \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prompt": "<string>"
}'
{
  "prompt": "What are the best neighborhoods for young families in San Francisco?",
  "response": "Based on our analysis, the top neighborhoods for young families in San Francisco are Noe Valley, West Portal, and Outer Sunset. These areas offer good school options, safer streets, and more family-friendly amenities like parks and playgrounds. Noe Valley has the highest concentration of young families, while West Portal offers better affordability with similar amenities. Outer Sunset provides more space and proximity to Ocean Beach, though with slightly longer commute times to downtown."
}

​
Overview

The Insights Chat API allows you to obtain location intelligence through natural language queries. This endpoint enables conversational access to insights by asking questions about locations, market trends, and real estate data.

To obtain an API key, please contact our sales team.

​
Authorization

​
Authorization
string
required

Your API key for authentication

​
Body

​
prompt
string
required

The natural language question or request about location insights

{
  "prompt": "What are the best neighborhoods for young families in San Francisco?",
  "response": "Based on our analysis, the top neighborhoods for young families in San Francisco are Noe Valley, West Portal, and Outer Sunset. These areas offer good school options, safer streets, and more family-friendly amenities like parks and playgrounds. Noe Valley has the highest concentration of young families, while West Portal offers better affordability with similar amenities. Outer Sunset provides more space and proximity to Ocean Beach, though with slightly longer commute times to downtown."
}

​
Notes

  • The response includes:
    • prompt: The original question you asked (echoed back)
    • response: A detailed answer based on available location data and insights
  • You can ask a wide variety of questions about locations, including:
    • Neighborhood comparisons
    • Market trends
    • Demographics information
    • Investment potential
    • Amenities and services
  • The system uses natural language processing to interpret your questions and provide relevant insights
  • For location-specific queries, including the city or region in your question will yield more precise answers
  • Responses are generated based on FindLoka’s proprietary location data and analysis