https://github.com/nycplanning/api-geosupport
flask api for geosupport python bindings
https://github.com/nycplanning/api-geosupport
api-geosupport flask-api geosupport geosupport-python-bindings nyc
Last synced: 3 months ago
JSON representation
flask api for geosupport python bindings
- Host: GitHub
- URL: https://github.com/nycplanning/api-geosupport
- Owner: NYCPlanning
- License: mit
- Created: 2019-04-19T20:30:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-17T15:52:08.000Z (almost 5 years ago)
- Last Synced: 2025-04-10T04:16:32.402Z (6 months ago)
- Topics: api-geosupport, flask-api, geosupport, geosupport-python-bindings, nyc
- Language: Python
- Size: 43 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# api-geosupport 
flask api for geosupport python bindings
## Try it now!
Fire up an geosupport api on [Heroku](https://www.heroku.com/) with a single click:
[](https://heroku.com/deploy)
## 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