Community Highlights API Documentation

The Proximitii Community Highlights API returns 10 community scorecards and up to 20 local highlights for a selected radius. It combines local lifestyle and demographic data into display-ready community insights.

Displaying this API's data on a public page? Show the Powered by Proximitii logo directly below it. See API Attribution.

Example Calls

node.js

const params = new URLSearchParams({
  lat: 40.778832684988224,
  lon: -73.98103168840414,
  radius: 500,
  munit: 'm',
  country: 'us'
});

const response = await fetch(
  `https://api.proximitii.com/v1/community-highlights/?${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-highlights/';
$headers = [
  'Public-Key: YOUR_PUBLIC_KEY',
  'Private-Key: YOUR_PRIVATE_KEY'
];
$params = [
  'lat' => 40.778832684988224,
  'lon' => -73.98103168840414,
  'radius' => 500,
  'munit' => 'm',
  'country' => 'us'
];

$ch = curl_init($url . '?' . http_build_query($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$body = json_decode(curl_exec($ch), true);
?>

Keys

Community Highlights API requests require both a public and private key. Call the API from your backend so the private key is not exposed publicly. Send keys as request headers named Public-Key and Private-Key.

Values

Use the supported parameter values below. If a parameter is omitted, its default is used.

Name	Description	Default Value	Accepted Values	Variable
Latitude	Sets the latitude of the location being analyzed.	N/A	Decimal between -90 and 90	lat
Longitude	Sets the longitude of the location being analyzed.	N/A	Decimal between -180 and 180	lon or lng
Country	Selects the demographic dataset and scoring ranges.	us	us or ca	country
Radius	Sets the search area.	500	100 to 6400 meters	radius
Radius Unit	Sets the radius unit. With `mi`, the supplied radius is treated as miles.	m	m or mi	munit

Sample Output

{
  "data": {
    "scorecards": [
      {
        "id": "walkability",
        "title": "Walkability",
        "icon": "active",
        "score": 8.6,
        "rating": "Very Walkable",
        "description": "Daily destinations are easy to reach on foot."
      }
    ],
    "highlights": [
      {
        "id": "dining-variety",
        "title": "Dining Variety",
        "icon": "dining",
        "score": 8.1,
        "rating": "Strong",
        "description": "Restaurants and cafes create more ways to enjoy the area."
      }
    ]
  },
  "status": {
    "code": "201",
    "message": "Created"
  }
}