Skip to main content

CrimeDataResponse

Complete crime data API response.

query objectrequired

Echo of query parameters

latLat (number)required
lonLon (number)required
radius_miRadius Mi (number)required
include_crime_summaryInclude Crime Summary (boolean)required
startStart (string)nullable
endEnd (string)nullable
categoriesstring[]nullable
crime_instances object[]

List of crime records

  • Array [
  • idId (integer)nullable
    datetimeDatetime (string)nullable

    ISO 8601 datetime of incident

    latLat (number)required

    Incident latitude

    lonLon (number)required

    Incident longitude

    distance_miDistance Mi (number)nullable

    Distance from search point in miles

    offense_codeOffense Code (string)nullable

    NIBRS offense code

    offense_categoryOffense Category (string)nullable

    Crime category

    offense_descriptionOffense Description (string)nullable

    Description of offense

    severitySeverity (string)nullable

    Severity level (Minor, Low, Moderate, High, Severe)

    crime_typeCrime Type (string)nullable

    Crime type category

    addressAddress (string)nullable

    Anonymized incident address

    agencyAgency (string)nullable
    victim_sexVictim Sex (string)nullable
    victim_raceVictim Race (string)nullable
    victim_age_groupVictim Age Group (string)nullable
    offender_sexOffender Sex (string)nullable
    offender_raceOffender Race (string)nullable
    offender_age_groupOffender Age Group (string)nullable
    crime_againstCrime Against (string)nullable
    reference_idReference Id (string)nullable
  • ]
  • summary objectnullable

    Aggregated statistics (if requested)

    totalTotal (integer)

    Total crime count

    Default value: 0
    by_category object

    Crime counts by category

    property name*integer
    by_severity object

    Crime counts by severity level

    property name*integer
    meta objectrequired

    Response metadata

    countCount (integer)required

    Number of records returned

    truncatedTruncated (boolean)required

    Whether there are more records available

    next_cursorNext Cursor (string)nullable

    Cursor for fetching next page

    compute_msCompute Ms (integer)nullable

    Query computation time in milliseconds

    location_info objectnullable

    Geocoded location information

    formatted_addressFormatted Address (string)nullable
    street_addressStreet Address (string)nullable
    cityCity (string)nullable
    stateState (string)nullable
    state_codeState Code (string)nullable
    countyCounty (string)nullable
    postal_codePostal Code (string)nullable
    latitudeLatitude (number)nullable
    longitudeLongitude (number)nullable
    geohash8Geohash8 (string)nullable
    CrimeDataResponse
    {
    "query": {
    "lat": 0,
    "lon": 0,
    "radius_mi": 0,
    "include_crime_summary": true,
    "start": "string",
    "end": "string",
    "categories": [
    "string"
    ]
    },
    "crime_instances": [
    {
    "id": 0,
    "datetime": "string",
    "lat": 0,
    "lon": 0,
    "distance_mi": 0,
    "offense_code": "string",
    "offense_category": "string",
    "offense_description": "string",
    "severity": "string",
    "crime_type": "string",
    "address": "string",
    "agency": "string",
    "victim_sex": "string",
    "victim_race": "string",
    "victim_age_group": "string",
    "offender_sex": "string",
    "offender_race": "string",
    "offender_age_group": "string",
    "crime_against": "string",
    "reference_id": "string"
    }
    ],
    "summary": {
    "total": 0,
    "by_category": {},
    "by_severity": {}
    },
    "meta": {
    "count": 0,
    "truncated": true,
    "next_cursor": "string",
    "compute_ms": 0
    },
    "location_info": {
    "formatted_address": "string",
    "street_address": "string",
    "city": "string",
    "state": "string",
    "state_code": "string",
    "county": "string",
    "postal_code": "string",
    "latitude": 0,
    "longitude": 0,
    "geohash8": "string"
    }
    }