Geo Crime Stats API

The Geo Crime Stats API provides comprehensive crime statistics for any given ZIP code in the United States. It does this by utilizing the nominatim.openstreetmap.org and crimeometer.com APIs to fetch geographical coordinates and crime data respectively.

NOTE: This functionality is available for over 700 urban areas, predominantly encompassing larger cities. An error will be returned in the absence of any available data.

API Endpoint

Endpoint: /get-crime-data?zipcode=YOUR_ZIP_CODE&distance=DISTANCE_IN_MILES&time=TIME_IN_DAYS

Example Request

GET http://localhost:5000/get-crime-data?zipcode=12345&distance=5&time=30

• REQUIRED: Replace YOUR_ZIP_CODE with the actual ZIP code for which you want to get the crime data.
• OPTIONAL: Replace DISTANCE_IN_MILES with the diameter of the search area from the center of the ZIP code. Defaults to 1 mile.
• OPTIONAL: Replace TIME_IN_DAYS with the desired time period from today to be included in the response. Defaults to 180 days.

Requesting Data

You can request data from this microservice using an HTTP GET request to the API endpoint mentioned above. Here's an example of how you could do this using Python:

import requests

url = 'http://localhost:5000/get-crime-data?zipcode=10001&distance=2&time=30'
response = requests.get(url)
data = response.json()

In this example, we're fetching crime data for the ZIP code 10001, with a distance of 2 miles and time of 30 days.

JSON Response Structure

The JSON returned by the API endpoint has the following structure:

• distance: An integer indicating the data's area radius, measured in miles.

• time: An integer for the length of the period in days.

• population_count: An integer representing the total population of the encompassed area.

• incidents_count: An integer indicating the total number of reported crime incidents in the specified area over the last 6 months.

• incidents_types: An array containing individual incident reports. Each report is a dictionary with three fields:

  • incident_type: A string specifying the type of crime incident.
  • incident_type_count: An integer indicating the total number of reported incidents of this type in the last 6 months.
  • incident_type_ratio: A decimal that represents total crime incidents for the specific crime type normalized per 1,000 population.

• incidents_types_ratio: A decimal that represents total crime incidents normalized per 1,000 population.

• csi: A decimal value between 0-100, with 50 being the US average, that represents the Crime Safety Index for the area. The CSI is calculated based on the number of reported incidents, their types, and the population size. It provides a measure of the overall safety level of the area.