search

Code4HR / open-health-inspection-api

The API for the Open Health Inspection app
https://ohi-api.code4hr.org
GNU General Public License v2.0
7 stars 8 forks source link
official ohi

readme

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: 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: 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.