geosupport-api

by NYCPlanning

GitHub Readme.md

api-geosupport CircleCI

flask api for geosupport python bindings

Try it now!

Fire up an geosupport api on Heroku with a single click:

Deploy to Heroku

Instructions

  1. Using Docker: if you like to specify your own port:

    docker run -d -e PORT={YOUR_PORT} -p {YOUR_PORT}:{YOUR_PORT} sptkl/api-geosupport:latest
    

    if no port specified, by default, the flask app will run on 5000:

    docker run -d -p 5000:5000 sptkl/api-geosupport:latest
    
  2. Examples:

    • Geocode using borough:
      http://0.0.0.0:5000/geocode/1b?house_number=120&street_name=broadway&borough=MN
      
    • Goecode using zipcode:
      http://0.0.0.0:5000/geocode/1b?house_number=120&street_name=broadway&zip_code=10271
      
    • Get address suggestions with minimal input:
      http://0.0.0.0:5000/suggest?address=100 Gold
      
  3. Notes:

    • All Geosupport functions and parameters are supported.
  4. Next Steps:

    • write tests
    • figure out a better way to structure code