HackFargo API documentation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md

README.md

HackFargo API Documentation

HackFargo collects data form the City of Fargo and makes it accessible via a simple HTTP call.

Currently Available Datasets:

  • Dispatch Data

Dispatch Data

Instructions

Think of a data set that interests you and form a keyword to filter that data upon. In order to receive a list of incidents filtered by your keyword, you would need to make a HTTP GET request to a path formed by joining our API endpoint URL http://api.hackfargo.co and your keyword (formatted within the strcuture noted in the section below); like such http://api.hackfargo.co/calls/type/Party

Structure

Criteria Parameters
Last few days (15 by default) /calls
Data range /calls?start=6-20-2013&end=6-21-2013
Incident Type /calls/type/Party
Date Range + Incident Type /calls/type/Party?start=3-3-2014&end=3-4-2014

Notes

  • Filter according to your need. (The maximum amount of records returned in a call is currently capped at 10,000)
  • Requests should be made via HTTP GET requests.
  • Responses will be valid JSON data.
  • The date attribute is returned in the UNIX timestamp format.
  • For privacy and accuracy limitations, addresses are only accurate to the block level. Example 314 Broadway would show up as 300 Broadway.

Example

Description
Get noise related incidents filtered by the keyword loud for the date range 2-30-2014 to 3-30-2014.

Request URL
http://api.hackfargo.co/calls/type/loud/count?start=2-30-2014&end=3-30-2014

Response
Note that the following response is annotated with comments beginning with // to indicate what those parts mean. Since the JSON format doesn't have comments it should be considered as invalid.

[
  {
    "DataSetID": "DispatchLogs",
    "Lat": 46.81618741541262,
    "Long": -96.88359341719978,
    "Date": 1394258006,                             //_Unix_timestamp_format
    "Description": "LOUD PEOPLE/MARIJUANA ODOR",    //_User's_field_to_filter_against
    "Meta": {
      "id": 215986,
      "DateString": "3/7/2014 11:53:26 PM",
      "DateVal": 1394258006,
      "Address": "900 BLK 44 ST S",                 //_Addresses_are_only_accurate_to_block_level
      "NatureOfCall": "LOUD PEOPLE/MARIJUANA ODOR",
      "CallType": "Loud Party/People",
      "IncidentNumber": "",
      "Duration": "",
      "AdditionalInfo": "",
      "CFSID": -5202747,
      "VenueName": "FGO",
      "VenueDescription": "Fargo",
      "Block": "900",                               //_Addresses_are_only_accurate_to_block_level
      "StreetPrefix": "",
      "StreetPretype": "",
      "StreetName": "44",
      "StreetType": "ST",
      "StreetSuffix": "S",
      "Lat": 0,
      "Long": 0
    }
  },
  {
    "DataSetID": "DispatchLogs",
    "Lat": 46.830937295065304,
    "Long": -96.79115266298359,
    "Date": 1394164277,
    "Description": "LOUD TV",
    "Meta": {
      "id": 215829,
      "DateString": "3/6/2014 9:51:17 PM",
      "DateVal": 1394164277,
      "Address": "4200 BLK 9 AVENUE CIR S",
      "NatureOfCall": "LOUD TV",
      "CallType": "Loud Noise",
      "IncidentNumber": "2014-00013015",
      "Duration": "2326",
      "AdditionalInfo": "",
      "CFSID": -5202112,
      "VenueName": "FGO",
      "VenueDescription": "Fargo",
      "Block": "4200",
      "StreetPrefix": "",
      "StreetPretype": "",
      "StreetName": "9 AVENUE",
      "StreetType": "CIR",
      "StreetSuffix": "S",
      "Lat": 0,
      "Long": 0
    }
  }
]

Counts

If you just need the number of incidents, you may add /count towards the end of your request path. You will receive the number of incidents instead of the specific incidents themselves.

Example

Description
Get count of noise related incidents filtered by the keyword loud for the date range 6-20-12 to 6-21-2013.

Request URL
http://api.hackfargo.co/calls/type/loud/count?start=6-20-2012&end=6-21-2013

Response

{
      "count": 1649
}

Liability

The dispatch data provided via API by HackFargo is a service that repurposes data made available for public usage by the City of Fargo who deserve all credit for collection and assimilation of said data. The following is a disclaimer to the usage of the same data to which you will agree to by using HackFargo's services in any way, shape or manner - The Fargo Police Department allows access to its dispatch log online. The log is updated daily and is made available in the public interest. The log does not represent all of the daily activity of the department, nor does they always reflect what the officer found at the scene of the call. These calls also do not reflect the self-initiated or investigative activities of department officers.