open-health-inspection-api

The API for the Open Health Inspection app.

This API provides an interface to a MongoDB containing data from the Virginia Department of Health on inspections of food service facilities. Data is returned via JSON. To get the current list of routes make a call to the root URL.

It can be implemented using Flask with WSGI on Apache/Nginx, or very simply on Heroku with Gunicorn.

#####Routes implemented

Route	Description
/vendors	provides a complete list of food service vendors
Can be searched by adding any or all of the following parameters: Name ex. ohi-api.code4hr.org/vendors?name=Havana Address ex. api.openhealthinspection.com/vendors?address=Newtown Rd City ex. ohi-api.code4hr.org/vendors?city=Richmond Locality: The health district in which the vendor is located ex. ohi-api.code4hr.org/vendors?locality=Arlington Category: A broad categorization ex. ohi-api.code4hr.org/vendors?category=Restaurant type: A more granular breakdown ex. ohi-api.code4hr.org/vendors?type=Mobile Food Unit Score Above Number ex. ohi-api.code4hr.org/vendors?score_above=70 Score Below Number ex. ohi-api.code4hr.org/vendors?score_below=90 Limit Sets a limit on the number of results returned. The default is 1,500. Pretty Formats the results for easier reading in a browser. values are 'true' and 'false'. Default is false. Geospatial: Vendors near to a certain point can be found by providing a starting latitude <lat>, longitude <lng>, and distance in meters <dist> ex. ohi-api.code4hr.org/vendors?lat=36.6337272&lng=-81.7837303&dist=2000 This route returns name, API url, address, city, locality, category, type, score, and coordinates for each vendor. If a geospatial search was performed it will also return the distance from the starting point.
/vendor/<vendorid>	provides information on a specific vendor identified by <vendorid>
returns name, address, city, category, type, score, coordinates, and most recent inspection information
/inspections	list all inspections of a given vendor
Can be searched by adding any or all of the following parameters: vendorid ex. ohi-api.code4hr.org/inspections?vendorid=Backyard-Grillers-1078-Lee-Syd-Moore-Drive-Scottsburg-Virginia-24589 Inspections Performed Before Date: Specified in the form DD-MM-YYYY ex. ohi-api.code4hr.org/inspections?before=15-09-2013 Inspections Performed After Date: Specified in the form DD-MM-YYYY ex. ohi-api.code4hr.org/inspections?after=29-02-2012 Violation Text: The inspector's description of the violation contains this text ex. ohi-api.code4hr.org/inspections?violation_text=candle Violation Code: The municipal code of the violation ex. ohi-api.code4hr.org/inspections?violation_code=303 Score Above Number ex. ohi-api.code4hr.org/inspections?score_above=70 Score Below Number ex. ohi-api.code4hr.org/inspections?score_below=90 This route returns name, address, city, locality, category, type, score, last inspection date, and coordinates for each vendor. It will also return any inspections that met the search criteria.
/lives/<locality>
request a file in LIVES format for a given locality. See yelp.com/healthscores for format.
/lives-file/<locality>.zip
After a file is requested through /lives/, it will be available at this URL.
/bulk/
Provides bulk downloads of all data in the inspection database. Currently the data is only provided in JSON files but other formats will likely be available in the future. The data is currently updated weekly following a run of the Scraper. The files are produced using the mongoexport command line tool.