Community Snapshot AI Documentation

Example Calls

node.js

const gps = req.query.gps.split(',');
const lat = gps[0];
const lon = gps[1];

const params = new URLSearchParams({
    lat: lat,
    lon: lon,
    radius: 500,
    munit: 'm',
    country: 'us',
    paragraphs: 2,
    tone: 'professional',
    audience: 'general',
    audience_type: 'general',
    content_style: 'lifestyle',
    area_name: 'Upper East Side, New York',
    language: 'en'
});

const response = await fetch(
    `https://api.proximitii.com/v1/community-snapshot-ai/?${params.toString()}`,
    {
        method: 'GET',
        headers: {
            'Public-Key': 'YOUR_PUBLIC_KEY',
            'Private-Key': 'YOUR_PRIVATE_KEY'
        }
    }
);

const body = await response.json();

console.log(body);

PHP

<?php

	$url = "https://api.proximitii.com/v1/community-snapshot-ai/";

	$key_public = 'YOUR PUBLIC KEY';
	$key_private = 'YOUR PRVIATE KEY';

	
	$headers = [
		"Public-Key: {$key_public}",
		"Private-Key: {$key_private}"
	];
		
	$gps = explode (',', $_GET['gps']);
	$g_lat = $gps[0];
	$g_lon = $gps[1];
	
	$params = array(
		'lat' => $g_lat,
		'lon' => $g_lon,
		'radius' =>  '500',
		'munit' => 'm',
		'country' => 'us',
		'paragraphs' => 2,
		'tone' => 'professional',
		'audience' => 'general',
		'audience_type' => 'general',
		'content_style' => 'lifestyle',
		'area_name' => 'Upper East Side, New York',
		'language' => 'en'
	);
	
	$ch = curl_init ($url . '?' . http_build_query($params));
	curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_HEADER, 1);

	$data = curl_exec($ch);
	$json_data = json_decode ($data, true);

	$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
	$headers = trim(substr($data, 0, $header_size));
	$body = substr($data, $header_size);
	
	$body = json_decode ($body);
	$headers = explode("\n", $headers);
	
?>

Keys

In order to call the Community Snapshot AI successfully, you will need a public and private key. Make sure to store the keys safely and call the API on the backend so the private key is not exposed to the public.

Send keys as request headers named Public-Key and Private-Key.

Values

Please use only the supported parameter values listed below. If a parameter is omitted, the default value will be used automatically.

Sample Output

{
    "title": "Everyday Convenience With Local Access",
    "content": [
        "Just a short stroll from your door, you will find many of the conveniences that make everyday life easier. Whether you are picking up a quick meal at Jersey Mikes, meeting friends for coffee at Goddess and the Baker, or running daily errands nearby, the neighborhood offers a highly walkable environment where essentials are always within reach. Multiple bus stops located just minutes away provide convenient access throughout the city, making commuting, appointments, and weekend outings simple without relying heavily on a vehicle. The areas strong walkability helps residents enjoy a more connected lifestyle, with dining, services, and everyday amenities woven naturally into the surrounding streetscape.",
        "For those who value an active and balanced lifestyle, the neighborhood offers a variety of recreation and wellness options close to home. Northern Trust open space provides a welcome escape for walking, relaxing, or enjoying time outdoors, while CorePower Yoga offers a convenient destination for fitness and wellness routines. Nearby health clinics, pharmacies, and essential services add another layer of convenience, making it easy to manage day-to-day needs. Combined with its mix of amenities, accessibility, and urban energy, the area delivers a lifestyle that balances convenience, connectivity, and well-being."
    ],
    "status": {
        "code": "201",
        "message": "Created"
    }
}