trees-api-v2

Setup

python3 -m venv env
source env/bin/activate
cp config/settings/sample.local.py config/settings/local.py
pip install -r requirements.txt

Create local.py and edit for database credentials:

cp config/settings/sample.local.py config/settings/local.py

Setup database:

./manage.py sqlcreate  # use output to create database user
./manage.py migrate

Usage

Run development server

./manage.py runserver

Create config file like the following:

feature_name: 's_uferbaeume'
url: 'https://fbinter.stadt-berlin.de/fb/wfs/data/senstadt/s_uferbaeume?service=wfs&version=2.0.0&request=GetFeature&typeNames=s_uferbaeume'
file_name: /srv/trees/files/s_uferbaeume.xml
fields:
  identifier: gml_id
  species: ART
  genus: GATTUNG
  borough: BEZIRK
  year: PFLANZJAHR
  age:
  circumference: STAMMUMFAN
  height: BAUMHOEHE

where feature_name is an assigned name, url is the full wfs request to the service, file_name is the place to store the download on the local system, and fields is a mapping of the attributes of the api to the property fields of the service.

Then, fetch and ingest the data from the WFS service using:

./manage.py fetch /path/to/config.yml
./manage.py ingest /path/to/config.yml

Making queries

(On the development server the api is available at http://localhost:8000.)

• Filter trees with given properties:
  • https://trees.codefor.de/api/v2/trees/?genus=Abies
• For numerical fields (year, age, circumference, height) gt (>), gte (>=), lt (<), lte (<=) can be used:
  • https://trees.codefor.de/api/v2/trees/?height__gt=10
• For string fields (identifier, species, genus, borough) iexact (case insensitive) and contains can be used:
  • https://trees.codefor.de/api/v2/trees/?genus__iexact=abies
• All trees with a given distance to point (or less) can be retrieved:
  • https://trees.codefor.de/api/v2/trees/?dist=100&point=13.381018,52.498606
• Histogram of species, genus, borough, e.g.:
  • https://trees.codefor.de/api/v2/boroughs/
  • https://trees.codefor.de/api/v2/species/?species__contains=Robinia
  • https://trees.codefor.de/api/v2/genera/?genus__iexact=QUERCUS