{r311} is an R interface to the international standard
open311. Open311 APIs are used for civic
issue management and public service communication. The standard allows
administrations to better manage citizen requests, citizens to more
easily submit requests, and (hence this package) researchers and data
scientists to access data regarding public service communication.
{r311} supports the seamless management and supplementation of
available endpoints, the selection of appropriate APIs to access, and
the retrieval of civic service and request data. Custom queries and
extensions (e.g. from CitySDK) are implicitly supported. {r311} is
designed to require a minimal amount of dependencies, but allow for easy
integration into common R frameworks such as the tidyverse, sf or
xml2.
You can install {r311} from CRAN with:
install.packages("r311")Or you can install the development version from GitHub with:
# install.packages("remotes")
remotes::install_github("rOpenGov/r311")The following example loads {r311}, sets up a jurisdiction and
retrieves a small amount of data on service tickets in Cologne, Germany.
library(r311)
o311_api("Cologne")
o311_requests()
#> Simple feature collection with 100 features and 11 fields
#> Geometry type: POINT
#> Dimension: XY
#> Bounding box: xmin: 6.822994 ymin: 50.85606 xmax: 7.100928 ymax: 51.06279
#> Geodetic CRS: WGS 84
#> # A tibble: 100 × 12
#> service_request_id title description address_string service_name
#> <chr> <chr> <chr> <chr> <chr>
#> 1 20481-2024 #20481-2024 Schro… "31.08.202… 51065 Köln - … Schrottfahr…
#> 2 20482-2024 #20482-2024 Wilde… "Vor Haus … 51105 Köln - … Wilder Müll
#> 3 20483-2024 #20483-2024 Defek… "gefährlic… 50677 Köln - … Defekte Obe…
#> 4 20484-2024 #20484-2024 Straß… "auffahrra… 50674 Köln - … Straßenbaus…
#> 5 20485-2024 #20485-2024 Wilde… <NA> 50765 Köln - … Wilder Müll
#> 6 20486-2024 #20486-2024 Kölne… "Grünfläch… 50765 Köln - … Kölner Grün
#> 7 20487-2024 #20487-2024 Defek… <NA> 51147 Köln - … Defekte Obe…
#> 8 20488-2024 #20488-2024 Schro… "Hallo, an… 50825 Köln - … Schrottfahr…
#> 9 20489-2024 #20489-2024 Wilde… "Evastr Ec… 51149 Köln - … Wilder Müll
#> 10 20490-2024 #20490-2024 Wilde… "Wilder Mü… 50827 Köln - … Wilder Müll
#> # ℹ 90 more rows
#> # ℹ 7 more variables: requested_datetime <chr>, updated_datetime <chr>,
#> # status <chr>, media_url <chr>, status_note <chr>, service_code <chr>,
#> # geometry <POINT [°]>{r311} is powered by a JSON of available APIs (see
here).
This list does not claim to be comprehensive nor up-to-date at all times
but is updated from time to time. If an API is found to be unavailable
for an extended period of time, it will be marked as “questioning”.
Questionable APIs will be removed on the next release.
If you know about a stable open311 API that should be added to the list,
please consider opening an issue. Otherwise, you can also just use the
o311_add_endpoint() function to add the API locally.