How to become ohsome part 9 – More ways to access the ohsome API

At long last, welcome back to a new blog post of the “How to become ohsome“-series. As it’s been quite a while since you got an introduction to how to access the ohsome API, we would like to pick up this topic one more time this month. The former post with different ways to access the ohsome API is to be found here. Some new tools are available to help you analyze OpenStreetMap data. Below is a brief overview of the ohsome-py package, the ohsome R package, the ohsome QGIS plug-in ohsomeTools and ohsome2x. For each of the clients, we provide an example of how to query for monthly counts of school buildings (→ building=school) which are mapped as building outline (→ type:way) within a given boundary (“yourboundary.geojson“).

Access via python with the ohsome-py package:

If you want to analyze data with Python, the ohsome-py package can be your tool of choice and can be easily installed using pip. How it works is listed here, as well as an explanation of how to use it. For an even more in-depth introduction to using the ohsome-py package, you can check out this use case about public green spaces.

A request with ohsome-py could look like this:

import ohsome
import geopandas as gpd
client = ohsome.OhsomeClient()

bpolys = gpd.read_file("/yourpath/yourboundary.geojson")
example = client.elements.count.post(bpolys=bpolys,
                                      time='2010-01-01/2021-11-01/P1M',
                                      filter="type:way and building=school")
example_df = response.as_dataframe()

Access via R with the ohsome R package:

If you prefer to work with R, don’t worry, we have got you covered! One other of our projects is the ohsome R package, which allows you to send requests to the ohsome API via R. Again, you can find a very detailed explanation on how to install and use it here.

The ohsome R package is currently at an experimental stage. You can install it from Github.  While all kinds of queries to the ohsome API are possible with the package, it works most comfortably for OSM elements aggregation at the moment. A new version with full functionality is expected to be submitted to CRAN in the very near future.

A request with the ohsome R package could look like this:

library(ohsome)
library(sf)

htbo_example <- read_sf("yourboundary.geojson")
query <- ohsome_elements_count(
    boundary = htbo_example,
    filter = "type:way and building=school",
    time="2010-01-01/2021-11-01/P1M"
)
example <- ohsome_post(query)

Access via ohsomeTools:

If you want to analyze your data with QGIS and visualize it on a map, then the ohsome QGIS Plug-In (ohsomeTools) is the right tool for you. With it you can access the ohsome API directly in QGIS instead of sending a separate request and loading the data into your GIS. Please note that only QGIS v3.14 or newer is supported!

A very convenient feature of this tool is the automatic activation of the QGIS native temporal controller, if the geometry is suitable. Note that ohsomeTools has not yet been released in a public repository, but this will happen as soon as a suitable version of it is ready.

Again, you can find a short introduction on how to install and use the tool here. As you will surely notice, sending a request as well as using the output-file, is possible with very few clicks and in short time, which makes this tool a great addition for QGIS based examinations.

A request with ohsomeTools could look like this:

{
  "ohsomeQuery": {
    "queryType": "elements/count/groupBy/boundary",
    "filter": "building=school and type:way",
    "time": "2010-01-01/2021-11-01/P1M"
  },
  "source": {
    "geometryId": "id",
    "name": "yourboundary.geojson",
    "store": { "path": "yourboundary.geojson", "type": "geojson" }
  },
  "target": {
    "horizontalTimestampColumns": false,
    "createGeometry": true,
    "transformToWebmercator": false,
    "storeZeroValues": true,
    "computeValuePerArea": true,
    "name": "htbo_ohsome2x_example_output.geojson",
    "store": { "path": "htbo_ohsome2x_example_output.geojson",
    "type": "geojson" }
  }
}