Proximitii Book a Demo

Documentation

Installation, customization, API and map documentation for Proximitii products.

Last updated: 2026-10-21

Start here

Build local context into your experience.

Choose a widget for a ready-made experience, an API for custom data views, or Maps for location discovery. You will need the appropriate Proximitii key before installing a product.

Products

Find the right guide.

Widgets

Super WidgetCombine lifestyle, demographics, community highlights and crime in one address-level experience. Local Lifestyle WidgetShow scores, nearby places, maps and everyday lifestyle context. Demographics WidgetDisplay population, households, education and other demographic insights for a selected radius. Community Highlights WidgetPresent community scorecards and local highlights together. Crime WidgetAdd location-specific crime context and map views. Local Insights WidgetConnect visitors to a wider local profile and report experience. Climate WidgetShow climate risk categories, highlights and report options for a location.

APIs

Local Lifestyle APIRequest lifestyle scores, nearby places and proximity details. Demographics APIRequest US or Canadian demographic data for a selected location and radius. Community Highlights APIRetrieve community scorecards and local highlights. Community Snapshot AIGenerate a written community summary from local data. Crime Stats APIRequest crime statistics and supporting context for a location. Crime Riskmap APIRequest PNG crime risk tiles for an overlay on your existing web map. Climate APIRequest climate risk data for US and Canadian locations. Location APIIdentify the country, region, city, neighborhood and nearby street intersection for US or Canadian coordinates.

Maps

Proximitii MapsInstallation, configuration and map styles.

Getting started

Authentication

Widgets: public key

Request a widget key for the website where the widget will appear. Add that public key to your embed code and use it on the approved site.

APIs: public and private keys

Send both keys with your server-side API requests. Never expose the private key in browser code or a publicly viewable endpoint.

Need a key? Contact info@proximitii.com.

Displaying API data

API Attribution

When displaying Proximitii API data or generated content on a public page, place the official Powered by Proximitii logo directly below it. Keep the logo visible on desktop and mobile.

<div class="local-data">
  <!-- Render Proximitii API data here. -->
</div>
<img src="https://proximitii.com/assets/powered-by-proximitii.svg"
     alt="Powered by Proximitii" width="200" height="32">

Availability

Service Areas

Proximitii covers the United States, including all 50 states and Washington, D.C., and Canada's provinces and territories. Available data and features can vary by location and product.